🚀 Deposium CLI

Official command-line interface for Deposium — document search, knowledge graphs, and AI workflows, from your terminal.

📋 Overview

Deposium CLI is the terminal interface to the Deposium platform. It exposes:

• 🔍 Search: DuckDB VSS, FTS, and fuzzy matching
• 🔗 Graph: Network analysis and path finding
• 📊 Corpus: Statistics and quality evaluation
• 🤖 Compound AI: Multi-tool reasoning with Groq
• 🎨 Interactive mode: REPL for exploration

📚 Documentation

Detailed documentation is available in the docs/ directory:

User guides:

• Installation Guide
• Configuration Guide
• Best Practices (incl. self-service workflows)
• --on-ambiguous HITL flag

For SDK / programmatic consumers:

• MCP Auth Error Codes — MCPAuthError class + stable errorCode enum
• Contributing
• CHANGELOG

Command Reference

| Command | Description | | :-------------------------------------------------- | :------------------------------------ | | api-keys | Manage server-side API keys | | auth | Authenticate the CLI (local store) | | benchmark | Run LLM benchmarks (OpenBench) | | chat | Interactive AI chat mode | | compound | Multi-tool logic and reasoning | | config | CLI configuration management | | corpus | Corpus stats and evaluation | | dspy | Intelligent query routing (DSPy) | | duckdb | Database connection and federation | | evaluate | Metrics, dashboards, and feedback | | files | Manage documents (list/show/check/rm) | | graph | Graph analysis and traversal | | health | System health and connectivity | | intelligence | AI query analysis and hints | | leanrag | Optimized retrieval (LeanRAG) | | logs | View and search server logs | | mermaid | Diagram generation and querying | | query-history | Track and analyze query history | | search | Document search (Vector/FTS/Fuzzy) | | space | Manage workspaces (list/show/create) | | tools | List available MCP tools | | ui | Launch interactive dashboards | | upload-batch | Batch file upload utility |

📦 Quick Install

# Install globally via npm
npm install -g @deposium/cli

# Verify installation
deposium --version

See the Installation Guide for Docker, Bun, and local development installation methods.

🤝 Contributing

See Contributing Guide and Development Guide for details on how to get started.

🔒 Security

Found a vulnerability? See SECURITY.md for our disclosure policy.

📜 Changelog

See docs/CHANGELOG.md for the release history.

📄 License

MIT - The Seed Ship. See LICENSE.