Skip to content

Deposium CLI — deposium

npm

The Deposium CLI brings document search, graph queries and AI workflows straight to your terminal.

Installation

You need Node.js ^22.13.0 or >=24 (Node 23 is unsupported). Check that the installed CLI is version 1.5.2 or later.

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

Quick start

The CLI is included in the Pro, Teams, and Enterprise plans. It is preconfigured for Deposium online: no server address is needed.

Open Billing → API keys in the app, create a user key, and copy it when displayed. Then use it to sign in:

deposium auth login              # paste your key at the interactive prompt
deposium auth status             # check the connection

In the app, create a space and upload at least one document to it. Wait for processing to finish, then list your spaces and copy the ID of the one you created:

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

To explore the graph, see deposium graph search --help. To connect Claude, Codex, or another MCP client, follow the MCP guide.

Main commands

  • auth — sign in with a user key
  • search — semantic and graph search
  • graph — knowledge-graph exploration
  • chat — chat grounded in your documents
  • files / upload-batch — manage and import documents
  • api-keys — manage account API keys

For the details of each command (options and arguments), run deposium <command> --help.