1.0.3 • Published 4 months ago

node-ai-chatbot-cli v1.0.3

Weekly downloads
-
License
MIT
Repository
-
Last release
4 months ago

ChatGPT Chatbot CLI

ChatGPT CLI License Downloads

A lightweight Node.js package and CLI tool that allows developers to easily interact with OpenAI's ChatGPT API. Supports automated API key setup, simple chatbot creation, and seamless integration into JavaScript applications. Ideal for building AI-powered chatbots, assistants, and customer support solutions.

🚀 Features

  • Easy installation & setup (asks for API key automatically)
  • Works in JavaScript/Node.js projects (simple import & use)
  • CLI support for instant responses (no coding required)
  • Supports GPT-3.5, GPT-4, and future models
  • Environment variable storage for security

📌 Installation

Global Installation (Recommended)

npm install -g node-ai-chatbot-cli

This will install the CLI globally and ask for your OpenAI API key during setup.

Local Installation in a Project

npm install node-ai-chatbot-cli

If you install locally, you'll need to configure the API key manually using:

npx node-ai-chatbot-cli setup

⚡ Usage

1️⃣ Using the Chatbot in JavaScript

Import and Initialize the Bot:

const ChatGPTBot = require('node-ai-chatbot-cli');

const bot = new ChatGPTBot();
bot.sendMessage("Hello! How are you?")
    .then(response => console.log("ChatGPT:", response))
    .catch(error => console.error("Error:", error));

Using It with an API Key in Code:

const ChatGPTBot = require('node-ai-chatbot-cli');

const bot = new ChatGPTBot("your-openai-api-key-here");
bot.sendMessage("What is AI?")
    .then(console.log)
    .catch(console.error);

2️⃣ Using the CLI for Quick Responses

Run a quick ChatGPT query directly in the terminal:

npx node-ai-chatbot-cli "Tell me a joke"

Or if installed globally:

chatgpt-chatbot "Who is Elon Musk?"

3️⃣ Updating the API Key

If you need to change your OpenAI API key, run:

npx node-ai-chatbot-cli setup

🔧 Configuration

By default, the API key is stored in a .env file inside the package directory. You can also manually add your key to the .env file:

OPENAI_API_KEY=your-key-here

Alternatively, set it as an environment variable:

export OPENAI_API_KEY=your-key-here

📜 License

This project is licensed under the MIT License.


🤝 Contributing

Contributions are welcome! Feel free to fork the repo and submit a pull request.


🛠️ Support & Issues

If you encounter any issues or have feature requests, please open an issue on GitHub.

Happy coding! 🚀