Skip to content

Latest commit

 

History

History
124 lines (90 loc) · 2.83 KB

README.md

File metadata and controls

124 lines (90 loc) · 2.83 KB

DevBots

NPM Version NPM Downloads npm package minimized gzipped size NPM Type Definitions

Your go-to solution for creating and integrating chatbots seamlessly into your websites and applications. Devbots can be used from devbots.vercel.app and also available as CLI tool to create your prompted chatbot and easy integration into your websites.

Get API Key

To customize your devbot:

  1. Go to devbots.vercel.app
  2. Sign in to your account and navigate to dashboard
  3. Configure your prompt with title,logo and description
  4. Copy your API key
  5. Integrate the DevBot component in your application

For more information explore DevBots Docs

Installation

  1. npm

    npm i devbots
  2. pnpm

    pnpm add devbots
  3. yarn

    yarn add devbots
  4. bun

    bun add devbots

Props

Prop Type Description Required
apiKey string Your DevBots API key Yes
title string Chat widget title Yes

Example Usage

  1. React

    import { DevBot } from 'devbots';
    
    function App() {
      return (
        <div>
          <DevBot 
            apiKey="API_KEY"
            title="TITLE"
          />
        </div>
      );
    }

    Example File : App.tsx
    Deployed Link : devbots-example-react

  2. Html

    <script src="https://cdn.jsdelivr.net/gh/devhub-ai/cdns@master/devbots-chatbot.js"></script>
    <script>
      document.addEventListener('DOMContentLoaded', function () {
        new DevBot('API_KEY', 'TITLE');
      });
    </script>

    Example File : index.html
    Deployed Link : devbots-example-html

CLI

Installation

npm i -g devbots

Commands

  1. help

    devbots help
    • It will show you available commands.
  2. create devbot

    devbots create "title" "prompt"
    • It will generate an API_KEY.
  3. chat with devbot

    devbots chat "API_KEY" "query"

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

Support and Contribution

Need help? Visit our documentation or contact us.

We welcome contributions! Please feel free to submit a Pull Request.