DocsGPT

DocsGPT

Chatbot for documentation, that allows you to chat with your data. Privately deployable, provides AI knowledge sharing and integrates knowledge into your AI workflow

Stars: 15267

Visit
 screenshot

DocsGPT is an open-source documentation assistant powered by GPT models. It simplifies the process of searching for information in project documentation by allowing developers to ask questions and receive accurate answers. With DocsGPT, users can say goodbye to manual searches and quickly find the information they need. The tool aims to revolutionize project documentation experiences and offers features like live previews, Discord community, guides, and contribution opportunities. It consists of a Flask app, Chrome extension, similarity search index creation script, and a frontend built with Vite and React. Users can quickly get started with DocsGPT by following the provided setup instructions and can contribute to its development by following the guidelines in the CONTRIBUTING.md file. The project follows a Code of Conduct to ensure a harassment-free community environment for all participants. DocsGPT is licensed under MIT and is built with LangChain.

README:

DocsGPT 🦖

Open-Source RAG Assistant

DocsGPT is an open-source genAI tool that helps users get reliable answers from any knowledge source, while avoiding hallucinations. It enables quick and reliable information retrieval, with tooling and agentic system capability built in.

link to main GitHub showing Stars number link to main GitHub showing Forks number link to license file link to discord X (formerly Twitter) URL


☁️ Cloud Version💬 Discord📖 Guides
👫 Contribute🏠 Self-host⚡️ Quickstart

video-example-of-docs-gpt

Key Features:

  • 🗂️ Wide Format Support: Reads PDF, DOCX, CSV, XLSX, EPUB, MD, RST, HTML, MDX, JSON, PPTX, and images.
  • 🌐 Web & Data Integration: Ingests from URLs, sitemaps, Reddit, GitHub and web crawlers.
  • ✅ Reliable Answers: Get accurate, hallucination-free responses with source citations viewable in a clean UI.
  • 🔗 Actionable Tooling: Connect to APIs, tools, and other services to enable LLM actions.
  • 🧩 Pre-built Integrations: Use readily available HTML/React chat widgets, search tools, Discord/Telegram bots, and more.
  • 🔌 Flexible Deployment: Works with major LLMs (OpenAI, Google, Anthropic) and local models (Ollama, llama_cpp).
  • 🏢 Secure & Scalable: Run privately and securely with Kubernetes support, designed for enterprise-grade reliability.

Roadmap

  • [x] Full GoogleAI compatibility (Jan 2025)
  • [x] Add tools (Jan 2025)
  • [ ] Anthropic Tool compatibility
  • [ ] Add triggerable actions / tools (webhook)
  • [ ] Add OAuth 2.0 authentication for tools and sources
  • [ ] Manually updating chunks in the app UI
  • [ ] Devcontainer for easy development
  • [ ] Chatbots menu re-design to handle tools, scheduling, and more

You can find our full roadmap here. Please don't hesitate to contribute or create issues, it helps us improve DocsGPT!

Production Support / Help for Companies:

We're eager to provide personalized assistance when deploying your DocsGPT to a live environment.

Get a Demo 👋

Send Email 📧

QuickStart

[!Note] Make sure you have Docker installed

  1. Clone the repository and run the following command:
git clone https://github.com/arc53/DocsGPT.git
cd DocsGPT

On Mac OS or Linux, write:

  1. Run the following command:
./setup.sh

It will install all the dependencies and allow you to download the local model, use OpenAI or use our LLM API.

Otherwise, refer to this Guide for Windows:

On windows:

  1. Create a .env file in your root directory and set the env variables. It should look like this inside:

    LLM_NAME=[docsgpt or openai or others] 
    API_KEY=[if LLM_NAME is openai]
    

    See optional environment variables in the /application/.env_sample file.

  2. Run the following command:

    docker-compose up
  3. Navigate to http://localhost:5173/.

To stop, just run Ctrl + C.

[!Note] For development environment setup instructions, please refer to the Development Environment Guide.

Contributing

Please refer to the CONTRIBUTING.md file for information about how to get involved. We welcome issues, questions, and pull requests.

Architecture

Architecture chart

Project Structure

  • Application - Flask app (main application).

  • Extensions - Extensions, like react widget or discord bot.

  • Frontend - Frontend uses Vite and React.

  • Scripts - Miscellaneous scripts.

Code Of Conduct

We as members, contributors, and leaders, pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation. Please refer to the CODE_OF_CONDUCT.md file for more information about contributing.

Many Thanks To Our Contributors⚡

Contributors

License

The source code license is MIT, as described in the LICENSE file.

This project is supported by:

For Tasks:

Click tags to check more tools for each tasks

For Jobs:

Alternative AI tools for DocsGPT

Similar Open Source Tools

For similar tasks

For similar jobs