rag-chatbot-cli
v1.1.1
Published
A CLI tool to interact with a RAG system using Supabase and OpenAI.
Downloads
20
Maintainers
Readme
RAG Chatbot CLI
A command-line interface tool for building and interacting with a Retrieval-Augmented Generation (RAG) system using Supabase and OpenAI.
Features
- 🔄 Simple Installation: Install globally using npm
- 🧙♂️ Guided Setup: First-run wizard guides you through configuration
- 🔒 Secure Configuration: Credentials stored securely in a local config file
- 🤖 Interactive Chat: Ask questions and get AI responses powered by your documents
- 📝 Document Management: Add, list, and delete documents easily
- ✨ Rich Terminal Experience: Colorful, informative interface with spinners and tables
Installation
npm install -g rag-chatbot-cliPrerequisites
- Node.js 16 or higher
- A Supabase account with a project set up
- An OpenAI API key
Quick Start
Install the package globally:
npm install -g rag-chatbot-cliRun the CLI:
ragchatFollow the configuration wizard to set up your Supabase and OpenAI credentials.
Start chatting with your documents!
Commands
Configuration
ragchat configureDatabase Setup
ragchat setup-dbAdding Documents
ragchat add <file_path>Listing Documents
ragchat listDeleting Documents
ragchat delete <document_id_or_name>Interactive Chat Commands
While in the chat interface:
- Type any question to get AI responses
- Type
addto add a new document interactively - Type
exitto quit
License
MIT
Support
For issues, questions, or contributions, please visit the GitHub repository.
