Skip to content

CLI Reference ​

Complete command reference for QuantClaw.

Global Options ​

bash
quantclaw [OPTIONS] COMMAND [ARGS]
  • --help, -h — Show help message
  • --version, -v — Show version
  • --config PATH — Configuration file path
  • --log-level LEVEL — Log level: trace, debug, info, warn, error

Commands ​

agent ​

Send a message to the agent.

bash
quantclaw agent [OPTIONS] MESSAGE

Options:

  • --session SESSION — Session key to use (default: auto-generated)

Examples:

bash
# Send a message (creates a new session automatically)
quantclaw agent "Hello, introduce yourself"

# Use a specific session key
quantclaw agent --session my:project "What's the status?"

run ​

Send a message to the agent (alias for agent).

bash
quantclaw run MESSAGE

eval ​

One-shot prompt evaluation — no session history is created or used.

bash
quantclaw eval PROMPT

Examples:

bash
quantclaw eval "What is 2 + 2?"
quantclaw eval "Generate a random UUID"

gateway ​

Manage the RPC gateway.

bash
quantclaw gateway [SUBCOMMAND] [OPTIONS]

Subcommands:

gateway (no subcommand) ​

Run the gateway in the foreground.

bash
quantclaw gateway

gateway install ​

Install the background service definition (systemd --user on Linux, launchd user agent on macOS).

bash
quantclaw gateway install

gateway uninstall ​

Remove the background service definition.

bash
quantclaw gateway uninstall

gateway start / stop / restart ​

Control the background service.

bash
quantclaw gateway start
quantclaw gateway stop
quantclaw gateway restart

gateway status ​

Check whether the gateway background service is running.

bash
quantclaw gateway status

gateway call ​

Call any RPC method directly.

bash
quantclaw gateway call METHOD [JSON_PARAMS]

Examples:

bash
quantclaw gateway call gateway.health
quantclaw gateway call config.get '{"path":"llm.model"}'

sessions ​

Manage conversation sessions.

bash
quantclaw sessions SUBCOMMAND [OPTIONS]

sessions list ​

bash
quantclaw sessions list

sessions history ​

bash
quantclaw sessions history SESSION_KEY

sessions delete ​

bash
quantclaw sessions delete SESSION_KEY

sessions reset ​

bash
quantclaw sessions reset SESSION_KEY

models auth ​

Manage provider-backed login credentials such as OpenAI Codex OAuth and GitHub Copilot device auth.

bash
quantclaw models auth <login|status|logout> --provider <openai-codex|github-copilot>
quantclaw models auth login-github-copilot

Examples:

bash
quantclaw models auth login --provider openai-codex
quantclaw models auth status --provider openai-codex
quantclaw models auth logout --provider openai-codex
quantclaw models auth login --provider github-copilot
quantclaw models auth status --provider github-copilot
quantclaw models auth logout --provider github-copilot
quantclaw models auth login-github-copilot

openai-codex uses a browser-based OAuth flow and stores credentials in ~/.quantclaw/auth/openai-codex.json. github-copilot uses GitHub device login and stores long-lived credentials in ~/.quantclaw/auth/github-copilot.json; short-lived Copilot runtime tokens are cached in ~/.quantclaw/auth/github-copilot.token-cache.json. status shows whether cached credentials exist and whether they are still valid or refreshable. logout clears only the local cached credentials; your provider configuration is not switched automatically, so if it still points to openai-codex/* or github-copilot/*, subsequent requests will fail with an auth error until you log in again. Both auth stores update cached credentials via atomic replacement, so a failed write does not wipe an existing cached login.

config ​

Manage configuration.

bash
quantclaw config SUBCOMMAND [OPTIONS]

config get ​

bash
quantclaw config get                    # Full config
quantclaw config get llm.model         # Specific value (dot-path)

config set ​

bash
quantclaw config set llm.model "anthropic/claude-sonnet-4-6"

config unset ​

bash
quantclaw config unset llm.temperature

config reload ​

Hot-reload config without restarting the gateway.

bash
quantclaw config reload

config validate ​

bash
quantclaw config validate

config schema ​

bash
quantclaw config schema

skills ​

Manage skills.

bash
quantclaw skills SUBCOMMAND

skills list ​

bash
quantclaw skills list

skills install ​

Install a skill's dependencies.

bash
quantclaw skills install SKILL_NAME

memory ​

Search and inspect agent memory.

bash
quantclaw memory SUBCOMMAND [OPTIONS]
bash
quantclaw memory search "query string"
quantclaw memory search "recent events" --limit 10

Options:

  • --limit N — Result limit (default: 5)

memory status ​

bash
quantclaw memory status

cron ​

Manage scheduled tasks.

bash
quantclaw cron SUBCOMMAND

cron list ​

bash
quantclaw cron list

cron add ​

bash
quantclaw cron add NAME "0 9 * * *" "Send daily summary"

cron remove ​

bash
quantclaw cron remove TASK_ID

health ​

Quick health check — confirms the gateway is reachable.

bash
quantclaw health

status ​

Show connection and session counts.

bash
quantclaw status

logs ​

View gateway logs. Defaults to the last 50 lines.

bash
quantclaw logs            # Show last 50 lines
quantclaw logs -n 100     # Show last 100 lines
quantclaw logs -f         # Follow logs in real-time
quantclaw logs -n 20 -f   # Follow, starting from last 20 lines
FlagDescription
-n <count>Number of lines to show (default: 50)
-fFollow mode — stream new log entries as they arrive

On Linux, falls back to journalctl if no log file is found. On Windows, follow mode (-f) is not supported.

doctor ​

Run a full diagnostic check.

bash
quantclaw doctor

dashboard ​

Open the web dashboard in the browser.

bash
quantclaw dashboard

Opens http://127.0.0.1:18801.

onboard ​

Interactive setup wizard.

bash
quantclaw onboard [OPTIONS]

Options:

  • --quick — Quick setup with defaults (non-interactive)
  • --install-daemon — Also install the gateway background service definition

Examples:

bash
quantclaw onboard                     # Interactive
quantclaw onboard --quick             # Non-interactive
quantclaw onboard --install-daemon    # Interactive + install background service

In-Conversation Message Commands ​

While chatting, prefix a message with a slash command to control the session:

CommandEffect
/newStart a new session
/resetClear current session history
/compactManually trigger context compaction
/statusShow current session and queue status
/commandsList all available slash commands
/helpShow help text

Environment Variables ​

VariableDescription
OPENAI_API_KEYOpenAI / compatible provider API key
ANTHROPIC_API_KEYAnthropic API key
QUANTCLAW_LOG_LEVELLog level override (debug, info, warn, error)
QUANTCLAW_PORTSidecar IPC port (internal use, set automatically)

Ports ​

ServicePortPurpose
WebSocket RPC Gateway18800Main gateway for client connections
HTTP REST API / Dashboard18801Web UI and REST API

Complete Workflow Example ​

bash
# 1. Initial setup
quantclaw onboard --quick

# 2. Install and start the background service
quantclaw gateway install
quantclaw gateway start

# 3. Send a message
quantclaw agent "Hello!"

# 4. View session history
quantclaw sessions list
quantclaw sessions history SESSION_KEY

# 5. Search memory
quantclaw memory search "project notes"

# 6. Check status
quantclaw health
quantclaw status

# 7. Stream logs
quantclaw logs -f

Need help? Run quantclaw --help or quantclaw COMMAND --help.

Released under the Apache 2.0 License.