🚀 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 vector (VSS) and full-text (BM25) search
• 🔗 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
• Release and npm staging guide
• 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/BM25 FTS) | | space | Manage workspaces (list/show/create) | | temporal-assertion | Oracle: temporal-assertion fixtures | | tools | List available MCP tools | | ui | Launch interactive dashboards | | upload-batch | Batch file upload utility | | validate | Validate dossier (N1+N2+HITL) |

📦 Get started

Requires Node.js ^22.13.0 || >=24 (Node 23 is unsupported).

npm install -g @deposium/cli
deposium --version

Use CLI version 1.5.2 or newer for automatic connection to Deposium SaaS. No server URL setup is needed. If your installed version is older, see the configuration guide.

CLI access is included in the Pro, Teams, and Enterprise plans.

1. In the Deposium app's Billing page, open API Keys, create a personal user API key, and save it when shown.

2. Run deposium auth login and paste that key at the masked prompt.

3. Check the connection:

   deposium auth status

4. If you do not have a space yet, create one in the Deposium app and upload a document to it. Wait for processing to finish, then list your spaces and search using a phrase from that document:

   deposium space list
   deposium search "a phrase from your document" --space YOUR_SPACE_ID

Use a space ID from deposium space list in the search command. auth login uses a key you already created; it does not create one.

For URL questions, older versions, and local development, see the configuration guide. The installation guide covers other installation methods.

🤝 Contributing

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

Merging a new package version into main automatically stages it on npm after the release checks pass. A maintainer must approve it with npm 2FA before it becomes public; see the release guide.

🔒 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.