CLI Commands Reference
This page covers the terminal commands you run from your shell.
For in-chat slash commands, see Slash Commands Reference.
Global entrypoint
zaya [global-options] <command> [subcommand/options]
Global options
| Option | Description |
|---|---|
--version, -V | Show version and exit. |
--profile <name>, -p <name> | Select which Zaya profile to use for this invocation. Overrides the sticky default set by zaya profile use. |
--resume <session>, -r <session> | Resume a previous session by ID or title. |
--continue [name], -c [name] | Resume the most recent session, or the most recent session matching a title. |
--worktree, -w | Start in an isolated git worktree for parallel-agent workflows. |
--yolo | Bypass dangerous-command approval prompts. |
--pass-session-id | Include the session ID in the agent's system prompt. |
Top-level commands
| Command | Purpose |
|---|---|
zaya chat | Interactive or one-shot chat with the agent. |
zaya model | Interactively choose the default provider and model. |
zaya gateway | Run or manage the messaging gateway service. |
zaya setup | Interactive setup wizard for all or part of the configuration. |
zaya whatsapp | Configure and pair the WhatsApp bridge. |
zaya auth | Manage credentials — add, list, remove, reset, set strategy. Handles OAuth flows for Codex/Nous/Anthropic. |
zaya login / logout | Deprecated — use zaya auth instead. |
zaya status | Show agent, auth, and platform status. |
zaya cron | Inspect and tick the cron scheduler. |
zaya webhook | Manage dynamic webhook subscriptions for event-driven activation. |
zaya doctor | Diagnose config and dependency issues. |
zaya dump | Copy-pasteable setup summary for support/debugging. |
zaya debug | Debug tools — upload logs and system info for support. |
zaya backup | Back up Zaya home directory to a zip file. |
zaya import | Restore a Zaya backup from a zip file. |
zaya logs | View, tail, and filter agent/gateway/error log files. |
zaya config | Show, edit, migrate, and query configuration files. |
zaya pairing | Approve or revoke messaging pairing codes. |
zaya skills | Browse, install, publish, audit, and configure skills. |
zaya honcho | Manage Honcho cross-session memory integration. |
zaya memory | Configure external memory provider. |
zaya acp | Run Zaya as an ACP server for editor integration. |
zaya mcp | Manage MCP server configurations and run Zaya as an MCP server. |
zaya plugins | Manage Zaya Agent plugins (install, enable, disable, remove). |
zaya tools | Configure enabled tools per platform. |
zaya sessions | Browse, export, prune, rename, and delete sessions. |
zaya insights | Show token/cost/activity analytics. |
zaya claw | OpenClaw migration helpers. |
zaya dashboard | Launch the web dashboard for managing config, API keys, and sessions. |
zaya debug | Debug tools — upload logs and system info for support. |
zaya backup | Back up Zaya home directory to a zip file. |
zaya import | Restore a Zaya backup from a zip file. |
zaya profile | Manage profiles — multiple isolated Zaya instances. |
zaya completion | Print shell completion scripts (bash/zsh). |
zaya version | Show version information. |
zaya update | Pull latest code and reinstall dependencies. |
zaya uninstall | Remove Zaya from the system. |
zaya chat
zaya chat [options]
Common options:
| Option | Description |
|---|---|
-q, --query "..." | One-shot, non-interactive prompt. |
-m, --model <model> | Override the model for this run. |
-t, --toolsets <csv> | Enable a comma-separated set of toolsets. |
--provider <provider> | Force a provider: auto, openrouter, nous, openai-codex, copilot-acp, copilot, anthropic, gemini, huggingface, zai, kimi-coding, minimax, minimax-cn, kilocode, xiaomi, arcee. |
-s, --skills <name> | Preload one or more skills for the session (can be repeated or comma-separated). |
-v, --verbose | Verbose output. |
-Q, --quiet | Programmatic mode: suppress banner/spinner/tool previews. |
--image <path> | Attach a local image to a single query. |
--resume <session> / --continue [name] | Resume a session directly from chat. |
--worktree | Create an isolated git worktree for this run. |
--checkpoints | Enable filesystem checkpoints before destructive file changes. |
--yolo | Skip approval prompts. |
--pass-session-id | Pass the session ID into the system prompt. |
--source <tag> | Session source tag for filtering (default: cli). Use tool for third-party integrations that should not appear in user session lists. |
--max-turns <N> | Maximum tool-calling iterations per conversation turn (default: 90, or agent.max_turns in config). |
Examples:
zaya
zaya chat -q "Summarize the latest PRs"
zaya chat --provider openrouter --model anthropic/claude-sonnet-4.6
zaya chat --toolsets web,terminal,skills
zaya chat --quiet -q "Return only JSON"
zaya chat --worktree -q "Review this repo and open a PR"
zaya model
Interactive provider + model selector. This is the command for adding new providers, setting up API keys, and running OAuth flows. Run it from your terminal — not from inside an active Zaya chat session.
zaya model
Use this when you want to:
- add a new provider (OpenRouter, Anthropic, Copilot, DeepSeek, custom, etc.)
- log into OAuth-backed providers (Anthropic, Copilot, Codex, OpenRouter)
- enter or update API keys
- pick from provider-specific model lists
- configure a custom/self-hosted endpoint
- save the new default into config
zaya model (run from your terminal, outside any Zaya session) is the full provider setup wizard. It can add new providers, run OAuth flows, prompt for API keys, and configure endpoints.
/model (typed inside an active Zaya chat session) can only switch between providers and models you've already set up. It cannot add new providers, run OAuth, or prompt for API keys.
If you need to add a new provider: Exit your Zaya session first (Ctrl+C or /quit), then run zaya model from your terminal prompt.
/model slash command (mid-session)
Switch between already-configured models without leaving a session:
/model # Show current model and available options
/model claude-sonnet-4 # Switch model (auto-detects provider)
/model zai:glm-5 # Switch provider and model
/model custom:qwen-2.5 # Use model on your custom endpoint
/model custom # Auto-detect model from custom endpoint
/model custom:local:qwen-2.5 # Use a named custom provider
/model openrouter:anthropic/claude-sonnet-4 # Switch back to cloud
By default, /model changes apply to the current session only. Add --global to persist the change to config.yaml:
/model claude-sonnet-4 --global # Switch and save as new default
If you've only configured OpenRouter, /model will only show OpenRouter models. To add another provider (Anthropic, DeepSeek, Copilot, etc.), exit your session and run zaya model from the terminal.
Provider and base URL changes are persisted to config.yaml automatically. When switching away from a custom endpoint, the stale base URL is cleared to prevent it leaking into other providers.
zaya gateway
zaya gateway <subcommand>
Subcommands:
| Subcommand | Description |
|---|---|
run | Run the gateway in the foreground. Recommended for WSL, Docker, and Termux. |
start | Start the installed systemd/launchd background service. |
stop | Stop the service (or foreground process). |
restart | Restart the service. |
status | Show service status. |
install | Install as a systemd (Linux) or launchd (macOS) background service. |
uninstall | Remove the installed service. |
setup | Interactive messaging-platform setup. |
Use zaya gateway run instead of zaya gateway start — WSL's systemd support is unreliable. Wrap it in tmux for persistence: tmux new -s zaya 'zaya gateway run'. See WSL FAQ for details.
zaya setup
zaya setup [model|tts|terminal|gateway|tools|agent] [--non-interactive] [--reset]
Use the full wizard or jump into one section:
| Section | Description |
|---|---|
model | Provider and model setup. |
terminal | Terminal backend and sandbox setup. |
gateway | Messaging platform setup. |
tools | Enable/disable tools per platform. |
agent | Agent behavior settings. |
Options:
| Option | Description |
|---|---|
--non-interactive | Use defaults / environment values without prompts. |
--reset | Reset configuration to defaults before setup. |
zaya whatsapp
zaya whatsapp
Runs the WhatsApp pairing/setup flow, including mode selection and QR-code pairing.
zaya login / zaya logout (Deprecated)
zaya login has been removed. Use zaya auth to manage OAuth credentials, zaya model to select a provider, or zaya setup for full interactive setup.
zaya auth
Manage credential pools for same-provider key rotation. See Credential Pools for full documentation.
zaya auth # Interactive wizard
zaya auth list # Show all pools
zaya auth list openrouter # Show specific provider
zaya auth add openrouter --api-key sk-or-v1-xxx # Add API key
zaya auth add anthropic --type oauth # Add OAuth credential
zaya auth remove openrouter 2 # Remove by index
zaya auth reset openrouter # Clear cooldowns
Subcommands: add, list, remove, reset. When called with no subcommand, launches the interactive management wizard.
zaya status
zaya status [--all] [--deep]
| Option | Description |
|---|---|
--all | Show all details in a shareable redacted format. |
--deep | Run deeper checks that may take longer. |
zaya cron
zaya cron <list|create|edit|pause|resume|run|remove|status|tick>
| Subcommand | Description |
|---|---|
list | Show scheduled jobs. |
create / add | Create a scheduled job from a prompt, optionally attaching one or more skills via repeated --skill. |
edit | Update a job's schedule, prompt, name, delivery, repeat count, or attached skills. Supports --clear-skills, --add-skill, and --remove-skill. |
pause | Pause a job without deleting it. |
resume | Resume a paused job and compute its next future run. |
run | Trigger a job on the next scheduler tick. |
remove | Delete a scheduled job. |
status | Check whether the cron scheduler is running. |
tick | Run due jobs once and exit. |
zaya webhook
zaya webhook <subscribe|list|remove|test>
Manage dynamic webhook subscriptions for event-driven agent activation. Requires the webhook platform to be enabled in config — if not configured, prints setup instructions.
| Subcommand | Description |
|---|---|
subscribe / add | Create a webhook route. Returns the URL and HMAC secret to configure on your service. |
list / ls | Show all agent-created subscriptions. |
remove / rm | Delete a dynamic subscription. Static routes from config.yaml are not affected. |
test | Send a test POST to verify a subscription is working. |
zaya webhook subscribe
zaya webhook subscribe <name> [options]
| Option | Description |
|---|---|
--prompt | Prompt template with {dot.notation} payload references. |
--events | Comma-separated event types to accept (e.g. issues,pull_request). Empty = all. |
--description | Human-readable description. |
--skills | Comma-separated skill names to load for the agent run. |
--deliver | Delivery target: log (default), telegram, discord, slack, github_comment. |
--deliver-chat-id | Target chat/channel ID for cross-platform delivery. |
--secret | Custom HMAC secret. Auto-generated if omitted. |
Subscriptions persist to ~/.zaya/webhook_subscriptions.json and are hot-reloaded by the webhook adapter without a gateway restart.
zaya doctor
zaya doctor [--fix]
| Option | Description |
|---|---|
--fix | Attempt automatic repairs where possible. |
zaya dump
zaya dump [--show-keys]
Outputs a compact, plain-text summary of your entire Zaya setup. Designed to be copy-pasted into Discord, GitHub issues, or Telegram when asking for support — no ANSI colors, no special formatting, just data.
| Option | Description |
|---|---|
--show-keys | Show redacted API key prefixes (first and last 4 characters) instead of just set/not set. |
What it includes
| Section | Details |
|---|---|
| Header | Zaya version, release date, git commit hash |
| Environment | OS, Python version, OpenAI SDK version |
| Identity | Active profile name, ZAYA_HOME path |
| Model | Configured default model and provider |
| Terminal | Backend type (local, docker, ssh, etc.) |
| API keys | Presence check for all 22 provider/tool API keys |
| Features | Enabled toolsets, MCP server count, memory provider |
| Services | Gateway status, configured messaging platforms |
| Workload | Cron job counts, installed skill count |
| Config overrides | Any config values that differ from defaults |
Example output
--- zaya dump ---
version: 0.8.0 (2026.4.8) [af4abd2f]
os: Linux 6.14.0-37-generic x86_64
python: 3.11.14
openai_sdk: 2.24.0
profile: default
zaya_home: ~/.zaya
model: anthropic/claude-opus-4.6
provider: openrouter
terminal: local
api_keys:
openrouter set
openai not set
anthropic set
nous not set
firecrawl set
...
features:
toolsets: all
mcp_servers: 0
memory_provider: built-in
gateway: running (systemd)
platforms: telegram, discord
cron_jobs: 3 active / 5 total
skills: 42
config_overrides:
agent.max_turns: 250
compression.threshold: 0.85
display.streaming: True
--- end dump ---
When to use
- Reporting a bug on GitHub — paste the dump into your issue
- Asking for help in Discord — share it in a code block
- Comparing your setup to someone else's
- Quick sanity check when something isn't working
zaya dump is specifically designed for sharing. For interactive diagnostics, use zaya doctor. For a visual overview, use zaya status.
zaya debug
zaya debug share [options]
Upload a debug report (system info + recent logs) to a paste service and get a shareable URL. Useful for quick support requests — includes everything a helper needs to diagnose your issue.
| Option | Description |
|---|---|
--lines <N> | Number of log lines to include per log file (default: 200). |
--expire <days> | Paste expiry in days (default: 7). |
--local | Print the report locally instead of uploading. |
The report includes system info (OS, Python version, Zaya version), recent agent and gateway logs (512 KB limit per file), and redacted API key status. Keys are always redacted — no secrets are uploaded.
Paste services tried in order: paste.rs, dpaste.com.
Examples
zaya debug share # Upload debug report, print URL
zaya debug share --lines 500 # Include more log lines
zaya debug share --expire 30 # Keep paste for 30 days
zaya debug share --local # Print report to terminal (no upload)
zaya backup
zaya backup [options]
Create a zip archive of your Zaya configuration, skills, sessions, and data. The backup excludes the zaya-agent codebase itself.
| Option | Description |
|---|---|
-o, --output <path> | Output path for the zip file (default: ~/zaya-backup-<timestamp>.zip). |
-q, --quick | Quick snapshot: only critical state files (config.yaml, state.db, .env, auth, cron jobs). Much faster than a full backup. |
-l, --label <name> | Label for the snapshot (only used with --quick). |
The backup uses SQLite's backup() API for safe copying, so it works correctly even when Zaya is running (WAL-mode safe).
Examples
zaya backup # Full backup to ~/zaya-backup-*.zip
zaya backup -o /tmp/zaya.zip # Full backup to specific path
zaya backup --quick # Quick state-only snapshot
zaya backup --quick --label "pre-upgrade" # Quick snapshot with label
zaya import
zaya import <zipfile> [options]
Restore a previously created Zaya backup into your Zaya home directory.
| Option | Description |
|---|---|
-f, --force | Overwrite existing files without confirmation. |
zaya logs
zaya logs [log_name] [options]
View, tail, and filter Zaya log files. All logs are stored in ~/.zaya/logs/ (or <profile>/logs/ for non-default profiles).
Log files
| Name | File | What it captures |
|---|---|---|
agent (default) | agent.log | All agent activity — API calls, tool dispatch, session lifecycle (INFO and above) |
errors | errors.log | Warnings and errors only — a filtered subset of agent.log |
gateway | gateway.log | Messaging gateway activity — platform connections, message dispatch, webhook events |
Options
| Option | Description |
|---|---|
log_name | Which log to view: agent (default), errors, gateway, or list to show available files with sizes. |
-n, --lines <N> | Number of lines to show (default: 50). |
-f, --follow | Follow the log in real time, like tail -f. Press Ctrl+C to stop. |
--level <LEVEL> | Minimum log level to show: DEBUG, INFO, WARNING, ERROR, CRITICAL. |
--session <ID> | Filter lines containing a session ID substring. |
--since <TIME> | Show lines from a relative time ago: 30m, 1h, 2d, etc. Supports s (seconds), m (minutes), h (hours), d (days). |
--component <NAME> | Filter by component: gateway, agent, tools, cli, cron. |
Examples
# View the last 50 lines of agent.log (default)
zaya logs
# Follow agent.log in real time
zaya logs -f
# View the last 100 lines of gateway.log
zaya logs gateway -n 100
# Show only warnings and errors from the last hour
zaya logs --level WARNING --since 1h
# Filter by a specific session
zaya logs --session abc123
# Follow errors.log, starting from 30 minutes ago
zaya logs errors --since 30m -f
# List all log files with their sizes
zaya logs list
Filtering
Filters can be combined. When multiple filters are active, a log line must pass all of them to be shown:
# WARNING+ lines from the last 2 hours containing session "tg-12345"
zaya logs --level WARNING --since 2h --session tg-12345
Lines without a parseable timestamp are included when --since is active (they may be continuation lines from a multi-line log entry). Lines without a detectable level are included when --level is active.
Log rotation
Zaya uses Python's RotatingFileHandler. Old logs are rotated automatically — look for agent.log.1, agent.log.2, etc. The zaya logs list subcommand shows all log files including rotated ones.
zaya config
zaya config <subcommand>
Subcommands:
| Subcommand | Description |
|---|---|
show | Show current config values. |
edit | Open config.yaml in your editor. |
set <key> <value> | Set a config value. |
path | Print the config file path. |
env-path | Print the .env file path. |
check | Check for missing or stale config. |
migrate | Add newly introduced options interactively. |
zaya pairing
zaya pairing <list|approve|revoke|clear-pending>
| Subcommand | Description |
|---|---|
list | Show pending and approved users. |
approve <platform> <code> | Approve a pairing code. |
revoke <platform> <user-id> | Revoke a user's access. |
clear-pending | Clear pending pairing codes. |
zaya skills
zaya skills <subcommand>
Subcommands:
| Subcommand | Description |
|---|---|
browse | Paginated browser for skill registries. |
search | Search skill registries. |
install | Install a skill. |
inspect | Preview a skill without installing it. |
list | List installed skills. |
check | Check installed hub skills for upstream updates. |
update | Reinstall hub skills with upstream changes when available. |
audit | Re-scan installed hub skills. |
uninstall | Remove a hub-installed skill. |
publish | Publish a skill to a registry. |
snapshot | Export/import skill configurations. |
tap | Manage custom skill sources. |
config | Interactive enable/disable configuration for skills by platform. |
Common examples:
zaya skills browse
zaya skills browse --source official
zaya skills search react --source skills-sh
zaya skills search https://mintlify.com/docs --source well-known
zaya skills inspect official/security/1password
zaya skills inspect skills-sh/vercel-labs/json-render/json-render-react
zaya skills install official/migration/openclaw-migration
zaya skills install skills-sh/anthropics/skills/pdf --force
zaya skills check
zaya skills update
zaya skills config
Notes:
--forcecan override non-dangerous policy blocks for third-party/community skills.--forcedoes not override adangerousscan verdict.--source skills-shsearches the publicskills.shdirectory.--source well-knownlets you point Zaya at a site exposing/.well-known/skills/index.json.
zaya honcho
zaya honcho [--target-profile NAME] <subcommand>
Manage Honcho cross-session memory integration. This command is provided by the Honcho memory provider plugin and is only available when memory.provider is set to honcho in your config.
The --target-profile flag lets you manage another profile's Honcho config without switching to it.
Subcommands:
| Subcommand | Description |
|---|---|
setup | Redirects to zaya memory setup (unified setup path). |
status [--all] | Show current Honcho config and connection status. --all shows a cross-profile overview. |
peers | Show peer identities across all profiles. |
sessions | List known Honcho session mappings. |
map [name] | Map the current directory to a Honcho session name. Omit name to list current mappings. |
peer | Show or update peer names and dialectic reasoning level. Options: --user NAME, --ai NAME, --reasoning LEVEL. |
mode [mode] | Show or set recall mode: hybrid, context, or tools. Omit to show current. |
tokens | Show or set token budgets for context and dialectic. Options: --context N, --dialectic N. |
identity [file] [--show] | Seed or show the AI peer identity representation. |
enable | Enable Honcho for the active profile. |
disable | Disable Honcho for the active profile. |
sync | Sync Honcho config to all existing profiles (creates missing host blocks). |
migrate | Step-by-step migration guide from openclaw-honcho to Zaya Honcho. |
zaya memory
zaya memory <subcommand>
Set up and manage external memory provider plugins. Available providers: honcho, openviking, mem0, hindsight, holographic, retaindb, byterover, supermemory. Only one external provider can be active at a time. Built-in memory (MEMORY.md/USER.md) is always active.
Subcommands:
| Subcommand | Description |
|---|---|
setup | Interactive provider selection and configuration. |
status | Show current memory provider config. |
off | Disable external provider (built-in only). |
zaya acp
zaya acp
Starts Zaya as an ACP (Agent Client Protocol) stdio server for editor integration.
Related entrypoints:
zaya-acp
python -m acp_adapter
Install support first:
pip install -e '.[acp]'
See ACP Editor Integration and ACP Internals.
zaya mcp
zaya mcp <subcommand>
Manage MCP (Model Context Protocol) server configurations and run Zaya as an MCP server.
| Subcommand | Description |
|---|---|
serve [-v|--verbose] | Run Zaya as an MCP server — expose conversations to other agents. |
add <name> [--url URL] [--command CMD] [--args ...] [--auth oauth|header] | Add an MCP server with automatic tool discovery. |
remove <name> (alias: rm) | Remove an MCP server from config. |
list (alias: ls) | List configured MCP servers. |
test <name> | Test connection to an MCP server. |
configure <name> (alias: config) | Toggle tool selection for a server. |
See MCP Config Reference, Use MCP with Zaya, and MCP Server Mode.
zaya plugins
zaya plugins [subcommand]
Unified plugin management — general plugins, memory providers, and context engines in one place. Running zaya plugins with no subcommand opens a composite interactive screen with two sections:
- General Plugins — multi-select checkboxes to enable/disable installed plugins
- Provider Plugins — single-select configuration for Memory Provider and Context Engine. Press ENTER on a category to open a radio picker.
| Subcommand | Description |
|---|---|
| (none) | Composite interactive UI — general plugin toggles + provider plugin configuration. |
install <identifier> [--force] | Install a plugin from a Git URL or owner/repo. |
update <name> | Pull latest changes for an installed plugin. |
remove <name> (aliases: rm, uninstall) | Remove an installed plugin. |
enable <name> | Enable a disabled plugin. |
disable <name> | Disable a plugin without removing it. |
list (alias: ls) | List installed plugins with enabled/disabled status. |
Provider plugin selections are saved to config.yaml:
memory.provider— active memory provider (empty = built-in only)context.engine— active context engine ("compressor"= built-in default)
General plugin disabled list is stored in config.yaml under plugins.disabled.
See Plugins and Build a Zaya Plugin.
zaya tools
zaya tools [--summary]
| Option | Description |
|---|---|
--summary | Print the current enabled-tools summary and exit. |
Without --summary, this launches the interactive per-platform tool configuration UI.
zaya sessions
zaya sessions <subcommand>
Subcommands:
| Subcommand | Description |
|---|---|
list | List recent sessions. |
browse | Interactive session picker with search and resume. |
export <output> [--session-id ID] | Export sessions to JSONL. |
delete <session-id> | Delete one session. |
prune | Delete old sessions. |
stats | Show session-store statistics. |
rename <session-id> <title> | Set or change a session title. |
zaya insights
zaya insights [--days N] [--source platform]
| Option | Description |
|---|---|
--days <n> | Analyze the last n days (default: 30). |
--source <platform> | Filter by source such as cli, telegram, or discord. |
zaya claw
zaya claw migrate [options]
Migrate your OpenClaw setup to Zaya. Reads from ~/.openclaw (or a custom path) and writes to ~/.zaya. Automatically detects legacy directory names (~/.clawdbot, ~/.moltbot) and config filenames (clawdbot.json, moltbot.json).
| Option | Description |
|---|---|
--dry-run | Preview what would be migrated without writing anything. |
--preset <name> | Migration preset: full (default, includes secrets) or user-data (excludes API keys). |
--overwrite | Overwrite existing Zaya files on conflicts (default: skip). |
--migrate-secrets | Include API keys in migration (enabled by default with --preset full). |
--source <path> | Custom OpenClaw directory (default: ~/.openclaw). |
--workspace-target <path> | Target directory for workspace instructions (AGENTS.md). |
--skill-conflict <mode> | Handle skill name collisions: skip (default), overwrite, or rename. |
--yes | Skip the confirmation prompt. |
What gets migrated
The migration covers 30+ categories across persona, memory, skills, model providers, messaging platforms, agent behavior, session policies, MCP servers, TTS, and more. Items are either directly imported into Zaya equivalents or archived for manual review.
Directly imported: SOUL.md, MEMORY.md, USER.md, AGENTS.md, skills (4 source directories), default model, custom providers, MCP servers, messaging platform tokens and allowlists (Telegram, Discord, Slack, WhatsApp, Signal, Matrix, Mattermost), agent defaults (reasoning effort, compression, human delay, timezone, sandbox), session reset policies, approval rules, TTS config, browser settings, tool settings, exec timeout, command allowlist, gateway config, and API keys from 3 sources.
Archived for manual review: Cron jobs, plugins, hooks/webhooks, memory backend (QMD), skills registry config, UI/identity, logging, multi-agent setup, channel bindings, IDENTITY.md, TOOLS.md, HEARTBEAT.md, BOOTSTRAP.md.
API key resolution checks three sources in priority order: config values → ~/.openclaw/.env → auth-profiles.json. All token fields handle plain strings, env templates (${VAR}), and SecretRef objects.
For the complete config key mapping, SecretRef handling details, and post-migration checklist, see the full migration guide.
Examples
# Preview what would be migrated
zaya claw migrate --dry-run
# Full migration including API keys
zaya claw migrate --preset full
# Migrate user data only (no secrets), overwrite conflicts
zaya claw migrate --preset user-data --overwrite
# Migrate from a custom OpenClaw path
zaya claw migrate --source /home/user/old-openclaw
zaya dashboard
zaya dashboard [options]
Launch the web dashboard — a browser-based UI for managing configuration, API keys, and monitoring sessions. Requires pip install zaya-agent[web] (FastAPI + Uvicorn). See Web Dashboard for full documentation.
| Option | Default | Description |
|---|---|---|
--port | 9119 | Port to run the web server on |
--host | 127.0.0.1 | Bind address |
--no-open | — | Don't auto-open the browser |
# Default — opens browser to http://127.0.0.1:9119
zaya dashboard
# Custom port, no browser
zaya dashboard --port 8080 --no-open
zaya profile
zaya profile <subcommand>
Manage profiles — multiple isolated Zaya instances, each with its own config, sessions, skills, and home directory.
| Subcommand | Description |
|---|---|
list | List all profiles. |
use <name> | Set a sticky default profile. |
create <name> [--clone] [--clone-all] [--clone-from <source>] [--no-alias] | Create a new profile. --clone copies config, .env, and SOUL.md from the active profile. --clone-all copies all state. --clone-from specifies a source profile. |
delete <name> [-y] | Delete a profile. |
show <name> | Show profile details (home directory, config, etc.). |
alias <name> [--remove] [--name NAME] | Manage wrapper scripts for quick profile access. |
rename <old> <new> | Rename a profile. |
export <name> [-o FILE] | Export a profile to a .tar.gz archive. |
import <archive> [--name NAME] | Import a profile from a .tar.gz archive. |
Examples:
zaya profile list
zaya profile create work --clone
zaya profile use work
zaya profile alias work --name h-work
zaya profile export work -o work-backup.tar.gz
zaya profile import work-backup.tar.gz --name restored
zaya -p work chat -q "Hello from work profile"
zaya completion
zaya completion [bash|zsh]
Print a shell completion script to stdout. Source the output in your shell profile for tab-completion of Zaya commands, subcommands, and profile names.
Examples:
# Bash
zaya completion bash >> ~/.bashrc
# Zsh
zaya completion zsh >> ~/.zshrc
Maintenance commands
| Command | Description |
|---|---|
zaya version | Print version information. |
zaya update | Pull latest changes and reinstall dependencies. |
zaya uninstall [--full] [--yes] | Remove Zaya, optionally deleting all config/data. |