Skip to content

CLI reference 1.9.2

Documented version.

Troubleshoot the CLI

The deposium command is not found

Check Node.js, the global npm prefix, and the command location in the same terminal:

node --version
npm prefix -g
command -v deposium

In PowerShell, use Get-Command deposium instead of command -v deposium.

With Node.js ^22.13.0 or >=24, reinstall the CLI:

npm install -g @deposium/cli@latest

The global npm executables folder must be available in your terminal's PATH. If you have just changed the PATH, open a new terminal. With mise or another Node.js version manager, also check the selected Node.js version: its global packages may differ.

An older version appears after updating

Compare the running version, published version, and installation location:

deposium --version
npm view @deposium/cli version
npm prefix -g
command -v deposium

In PowerShell, replace the last command with Get-Command deposium.

Another installation may take priority in the PATH, especially after switching Node.js versions. Select your intended Node.js version and run npm install -g @deposium/cli@latest again in the same terminal. Then exit and restart any running Deposium sessions.

An npm installation does not update a local Git checkout or every Node.js installation on your machine.

No update is offered

The startup mechanism requires CLI 1.6.0 or later, installed globally with npm. It applies only to deposium, chat, and interactive / i in an interactive terminal with TTY input and output.

It is disabled for help, --version, JSON output, other commands, CI, Bun, npm link, development, and npx. Offline, the check may fail without a message. To check and update manually, follow the update guide.

Sign-in fails

Create or renew a user key in Billing → API keys, then use the interactive prompt:

deposium auth login
deposium auth status

Check that you are using the account with access to the spaces you want. The CLI is preconfigured for Deposium online; no server URL is required. Never publish your key in a screenshot, ticket, or shared logs.

My documents are not found

In the app, check that the documents are in the intended space and processing has finished. Then list the spaces you can access:

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

Replace YOUR_SPACE_ID with the actual space ID. For a conversation, restart deposium chat and select that space.

To inspect a specific command, use deposium <command> --help or the command reference.

The UI demo does not start

demo-ui.ts is a CLI development example, not a Desktop command or a file in the globally installed npm package. Running npx tsx demo-ui.ts from deposium_desktop produces ERR_MODULE_NOT_FOUND because it is the wrong folder.

In an up-to-date CLI checkout (source 1.7.2 or later), run:

cd ../deposium_CLI
npm ci
npm run demo:ui

That folder change assumes you start in the sibling Desktop checkout. Otherwise, open the deposium_CLI directory containing package.json and demo-ui.ts. For a new development checkout:

git clone https://github.com/theseedship/deposium_CLI.git
cd deposium_CLI
npm ci
npm run demo:ui

Older sources imported removed helpers: changing folders or installing tsx alone does not fix them; update the source checkout first. The demo uses synthetic data without API calls, models or real service status. For normal CLI use, run deposium i; this demo is not required.