Skip to content

Getting started

This section holds the hand-written guides: installation, concepts, first steps.

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 with deposium --version.

npm install -g @deposium/cli

pnpm add -g @deposium/cli

bun add -g @deposium/cli

API access and authentication

The CLI is included in the Pro, Teams, and Enterprise plans. Open Billing → API keys, create a user key, and copy it when displayed.

CLI 1.5.2 or later connects to the SaaS service by default. auth login asks you to paste your key interactively.

deposium auth login
deposium auth status

In the app, create a space and upload at least one document to it. Wait for processing to finish, then copy that space's ID from deposium space list before searching your corpus.

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

Concepts

  • Spaces — workspaces isolating your document corpora.
  • Search — semantic and graph search over your documents.
  • Citations — every answer links back to the source passages.
  • MCP — connect AI assistants (Claude Code, Codex…) through the public MCP service, separately from the CLI flow.

Go further

  • All CLI commands

    Search, graph, document and key management from your terminal.

    Command reference

  • Connect your AI assistant

    Connect Deposium to Claude Code, Claude Desktop, Codex or Odysseus.

    MCP server