DARWIN

# Darwin RAG Local-first RAG engine. Ingest documents, index them with BM25 and embeddings, and search via hybrid/semantic/keyword retrieval. Runs as an MCP server for AI agent integration or via CLI. All local, all offline-capable. Built by [BrightDotDev](https://github.com/brightdotdev). [](LICENSE) --- ## Setup Internet is required for first-time setup to download and validate models. After that, everything runs offline. ### Interactive (guided) Detects your hardware, shows available models, lets you pick. Takes about 2 minutes. ```bash pip install darwin-rag darwin-admin setup interactive ``` ### One-shot: required (embedding only) Downloads and configures only the embedding model. No prompts, no choices. Fastest path to a working install. ```bash darwin-admin setup --preset required ``` ### One-shot: recommended (embedding + reranker + OCR) Also downloads a reranker and OCR model. Better search quality out of the box. ```bash darwin-admin setup --preset recommended ``` After setup, start the MCP server: ```bash darwin mcp --http --port 8765 ``` For a full setup walkthrough including Docker, from source, and API key configuration, see [docs/setup.md](https://github.com/BrightDotDev/DARWIN/blob/main/docs/setup.md). --- ## Connecting your agent ```bash # Generate config for Claude Desktop, Cursor, etc. darwin config claude # Generate config for all clients darwin config all --copy ``` Or point any MCP client directly: - **SSE:** `http://localhost:8765/sse` - **HTTP:** `http://localhost:8765/mcp` --- ## Commands **`darwin`** — user CLI (mcp, config) **`darwin-admin`** — power-user CLI (setup, models, store, pipeline, search, logs, system, uninstall, status) See [docs/admin.md](https://github.com/BrightDotDev/DARWIN/blob/main/docs/admin.md) for the full command reference. --- ## Documentation | Doc | What | |---|---| | [setup.md](https://github.com/BrightDotDev/DARWIN/blob/main/docs/setup.md) | Full setup walkthrough | | [architecture.md](https://github.com/BrightDotDev/DARWIN/blob/main/docs/architecture.md) | For developers and contributors | | [mcp.md](https://github.com/BrightDotDev/DARWIN/blob/main/docs/mcp.md) | MCP server, tools, resources | | [admin.md](https://github.com/BrightDotDev/DARWIN/blob/main/docs/admin.md) | Admin CLI reference | | [storage.md](https://github.com/BrightDotDev/DARWIN/blob/main/docs/storage.md) | DarwinStore | | [pipeline.md](https://github.com/BrightDotDev/DARWIN/blob/main/docs/pipeline.md) | Ingestion & indexing | | [retrieval.md](https://github.com/BrightDotDev/DARWIN/blob/main/docs/retrieval.md) | Search engine | | [models.md](https://github.com/BrightDotDev/DARWIN/blob/main/docs/models.md) | Model registry & inference | | [logger.md](https://github.com/BrightDotDev/DARWIN/blob/main/docs/logger.md) | Structured logging | | [orchestrators.md](https://github.com/BrightDotDev/DARWIN/blob/main/docs/orchestrators.md) | High-level business logic | --- ## Contributing Found a bug? Want to add something? You're welcome here. - **Issues** — open one at [github.com/BrightDotDev/DARWIN/issues](https://github.com/BrightDotDev/DARWIN/issues) - **Code** — fork, branch, PR. Keep it minimal. - **AI-generated code is fine** — but you own what you ship. Test it before submitting. Read [CONTRIBUTING.md](https://github.com/BrightDotDev/DARWIN/blob/main/CONTRIBUTING.md) for the full guidelines. --- ## License MIT with Attribution — see [LICENSE](LICENSE). Core architecture and implementation by [BrightDotDev](https://github.com/brightdotdev).