GraphCanon updated today · GitHub synced today
22k
Stars
2.5k
Forks
25
Open issues
179
Watchers
4mo
Last push
Python MITCreated May 24, 2023
Trust & integrity
Full report- Maintenance
- Slowing (122d since push)
- As of today · Source: github_public_v1
- Provenance
- Not a fork · Personal account
- As of today · Source: github_public_v1
- Security (OSV)
- 44 low (44 low)
- As of today · Source: osv@v1
Public GitHub metadata and optional OSV dependency scans. Signals, not a guarantee. Trust methodology.
Overview
A local tool to enable private chat interactions with documents using GPT models.
Capability facts
- Deploy
- Self-host
Source: dockerfile:docker-compose.yml · Jul 11, 2026
- Docker
- Dockerfile present
Source: dockerfile:docker-compose.yml · Jul 11, 2026
- CLI
- CLI entrypoint
Source: package.json:bin|scripts · Jul 11, 2026
- MCP server
- No MCP server detected
Source: repo_scan · Jul 11, 2026
- Languages
- python, javascript, typescript
Source: github.language+package.json · Jul 11, 2026
Categories
Compatibility
Sourced claims from the README excerpt - not unsourced marketing copy.
Node.js runtimeNode.js
Source: README excerpt (regex_v1, Jul 11, 2026)
# Install Node.js dependenciesSource link
Python runtimePython
Source: README excerpt (regex_v1, Jul 11, 2026)
# Install Python dependenciesSource link
Tags
README
🚀 Quick Start
Note: The installation is currently only tested on macOS.
Option 1: Docker Deployment
---
# Install Ollama locally (required even for Docker)
curl -fsSL https://ollama.ai/install.sh | sh
ollama pull qwen3:0.6b
ollama pull qwen3:8b
---
# Start with Docker (in a new terminal)
./start-docker.sh
---
# Install Python dependencies
pip install -r requirements.txt
---
# Install Node.js dependencies
npm install
---
# Install and start Ollama
curl -fsSL https://ollama.ai/install.sh | sh
ollama pull qwen3:0.6b
ollama pull qwen3:8b
ollama serve
---
### Detailed Installation
#### 1. Install System Dependencies
**Ubuntu/Debian:**
```bash
sudo apt update
sudo apt install python3.8 python3-pip nodejs npm docker.io docker-compose
macOS:
brew install python@3.8 node npm docker docker-compose
Windows:
---
# Install Python 3.8+, Node.js, and Docker Desktop
---
# Install Ollama
curl -fsSL https://ollama.ai/install.sh | sh
---
# Test installation
python -c "from rag_system.main import get_agent; print('✅ Installation successful!')"
---
### 🚀 Quick Start for Contributors
```bash
---
# Install Ollama and models
curl -fsSL https://ollama.ai/install.sh | sh
ollama pull qwen3:0.6b qwen3:8b
---
## 📄 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. For models, please check their respective licenses.
---