The project's README from github.com/arc53/DocsGPT. As one markdown file: README.md.
Private AI for agents, assistants and enterprise search
DocsGPT is an open-source AI platform for building intelligent agents and assistants. Features Agent Builder, deep research tools, document analysis (PDF, Office, web content, and audio), Multi-model support (choose your provider or run locally), and rich API connectivity for agents with actionable tools and integrations. Deploy anywhere with complete privacy control.
You can find our full roadmap here. Please don't hesitate to contribute or create issues, it helps us improve DocsGPT!
We're eager to provide personalized assistance when deploying your DocsGPT to a live environment.
Calling all developers and GenAI innovators! The DocsGPT Lighthouse Program connects technical leaders actively deploying or extending DocsGPT in real-world scenarios. Collaborate directly with our team to shape the roadmap, access priority support, and build enterprise-ready solutions with exclusive community insights.
[!Note] Make sure you have Docker installed
A more detailed Quickstart is available in our documentation
Clone the repository:
git clone https://github.com/arc53/DocsGPT.git
cd DocsGPT
For macOS and Linux:
Run the setup script:
./setup.sh
For Windows:
Run the PowerShell setup script:
PowerShell -ExecutionPolicy Bypass -File .\setup.ps1
Either script will guide you through setting up DocsGPT. Five options are available: using the public API, running locally, connecting to a local inference engine, using a cloud API provider, or building the docker image locally. The scripts will automatically configure your .env file and handle necessary downloads and installations based on your chosen option.
Navigate to http://localhost:5173/
To stop DocsGPT, open a terminal in the DocsGPT directory and run:
docker compose -f deployment/docker-compose.yaml down
(or use the specific docker compose down command shown after running the setup script).
[!Note] For development environment setup instructions, please refer to the Development Environment Guide.
Please refer to the CONTRIBUTING.md file for information about how to get involved. We welcome issues, questions, and pull requests.
docsgpt - Backend Flask application (the docsgpt Python package).
Extensions - Integrations and widgets (e.g., Chatwoot, React widget).
Scripts - Miscellaneous utility scripts.
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.
The source code license is MIT, as described in the LICENSE file.