Cave CLI

Command-line access to Cave tasks, chat, secrets, and service health checks.

Install

Run the CLI without installing it globally:

npx @cave-ai/cli --help

Or install it globally:

npm install -g @cave-ai/cli
cave --help

The npm package is @cave-ai/cli. The installed binary is cave.

Production Setup

Point the CLI at the production API and store an API key:

cave config set-api-url https://api.getcave.ai
cave auth set <api-key>
cave auth status

You can also configure it per shell session:

export CAVE_API_URL=https://api.getcave.ai
export CAVE_API_KEY=<api-key>
cave health ready

The persisted config file lives at ~/.config/cave/config.json. Environment variables override the config file.

Usage

cave <command> [options]

Most read commands support --format pretty and --format json.

Commands

Auth

cave auth set <api-key>
cave auth status
cave auth clear

Config

cave config show
cave config set-api-url https://api.getcave.ai

Health

cave health ready

Tasks

cave task list
cave task get <task-id>
cave task create "Ship CLI README" --status open --priority medium
cave task update <task-id> --status done
cave task delete <task-id>

Useful task filters:

cave task list --status open --limit 10
cave task list --q "cli" --format json

Chat

cave chat channels
cave chat create-channel general --type public
cave chat messages <channel-id>
cave chat send-message <channel-id> "Hello from the CLI"
cave chat toggle-reaction <message-id> ":wave:"

Secrets

cave secrets projects
cave secrets create-project app --description "Application secrets"
cave secrets environments <project-id>
cave secrets list <environment-id>
cave secrets create <environment-id> API_KEY <value>
cave secrets reveal <secret-id>

secrets also has the alias secret.

Updating

npm update -g @cave-ai/cli

Or use the latest published version directly:

npx @cave-ai/cli@latest --help