Skip to main content

Installation

Install the Dust CLI globally via npm:

Linux

The CLI depends on keytar for storing credentials. On Linux, keytar requires libsecret:
  • Debian / Ubuntu: sudo apt-get install libsecret-1-dev
  • Red Hat-based: sudo yum install libsecret-devel
  • Arch Linux: sudo pacman -S libsecret

Usage

When no command is provided, the chat command runs by default, opening an interactive chat with @Dust with access to your local filesystem.

Available commands

login

Authenticate with your Dust account.

status

Check your current authentication status.

logout

Log out from your Dust account.

chat

Chat with a Dust agent. This is the default command: running dust with no arguments opens an interactive chat session.
Flags: Examples:
Billing note: Interactive CLI chat (typing in the terminal UI) counts as regular human usage. Non-interactive messages (--message) count as programmatic usage and consume credits.

skill:init

Set up a Claude Code / Anthropic skill on your local coding agent (Claude Code, Codex, etc.) that teaches it how to use the Dust CLI to talk to Dust agents.
Running this scaffolds a SKILL.md in the appropriate .claude/skills/ directory. Once installed, your coding agent gains a skill explaining how to call Dust agents non-interactively (e.g. dust chat -a <agent> -m "..."), making it easy to pull context from Dust, post Slack messages, read Notion pages, and more, all from within your coding workflow.
For more on how Dust Skills relate to Anthropic/Claude Skills, see the Skills documentation and the Anthropic skills repository.

cache:clear

Clear the local CLI cache used for faster startup.

help

Display help information.

In-chat commands

While in an interactive chat session, type these with a forward slash:

Global options

Headless authentication

If you can’t sign in through a browser, you can sign in with an API key instead. Run dust login with your API key and workspace ID:
You can also set environment variables, then run dust login:
Only dust login reads these flags and environment variables. Other commands, such as dust chat, use the credentials that dust login saved. Command-line flags take precedence over environment variables.

What works with an API key

After signing in with an API key, interactive dust chat works. Commands that need your user profile return an authentication error, including non-interactive messages (dust chat --message) and dust status. To use them, sign in with dust login without an API key.

Security considerations

  • Prefer environment variables over CLI flags; flags may be visible in process listings.
  • Store API keys securely; avoid committing them to version control.
  • Use .env files locally and proper secrets management in CI/CD.