Skip to main content

CLI Commands

This is the command reference for the anyy binary. It reflects the current top-level --help output and the implemented command dispatch. Put global flags before the command; put command-specific flags after the command.

anyy [--profile NAME] [--profile-root PATH] [--role ROLE] COMMAND
anyy --version
anyy --resume SESSION_ID

Common Workflows

GoalCommand
Open the TUIanyy
Complete first setupanyy setup
Configure model/provideranyy setup model
Start resident runtimeanyy gateway start
Send one prompt through the gatewayanyy chat "prompt"
Check local healthanyy status then anyy doctor
Configure one channelanyy setup channels CHANNEL --write-config
Validate one channelanyy channels doctor CHANNEL
Preview AutoDream memory consolidationanyy memory dream --dry-run
Create a backupanyy backup create

This page lists implemented CLI command families. Runtime slash commands such as /sessions, /branch, and /compress are covered in Slash Commands.

Global Flags

FlagMeaning
--profile NAMESelect a profile by name.
--profile-root PATHSelect the base directory that contains profiles.
--role ROLESelect the initial Role for new sessions.
--resume IDResume an existing TUI session.
--home PATHAnyy home for the default TUI entrypoint.
--socket PATHGateway socket for the default TUI entrypoint.
--no-colorDisable colored output.
note

--home, --socket, and --resume are global only for the default TUI entrypoint. For subcommands, pass their flags after the command, such as anyy status --home PATH.

Top-level Commands

CommandPurpose
anyyStart the interactive TUI. If needed, the TUI starts an embedded gateway.
anyy chat PROMPTSend one prompt through the resident gateway.
anyy statusShow local and live gateway status.
anyy doctorRun local diagnostics.
anyy dashboardStart or manage the dashboard sidecar.
anyy configRender the resolved config summary.
anyy --versionPrint version information.

One-shot chat:

anyy chat [--home PATH] [--socket PATH] [--role ROLE] [--session ID] [--json] [--yes] PROMPT

chat requires a running resident gateway; the default TUI can start an embedded gateway for itself.

Gateway Commands

anyy gateway start [--home PATH]
anyy gateway restart [--home PATH]
anyy gateway status [--home PATH]
anyy gateway stop [--home PATH]

Gateway commands manage the resident background service for one home/profile. start installs the host service if supported and missing, then waits for the gateway to become reachable. restart also installs when necessary. status reports service state, process version, command version, home, and socket.

Setup Commands

anyy setup [--home PATH]
anyy setup model [--home PATH]
anyy setup model fallback [--home PATH]
anyy setup aux [--home PATH]
anyy setup aux CAP [--home PATH] [--probe]
anyy setup channels [--home PATH]
anyy setup channels CHANNEL [--home PATH] [--account-id ID] [--secret NAME=VALUE] [--set NAME=VALUE] [--write-config]
anyy setup channels weixin login [--home PATH] [--base-url URL] [--secret NAME]
anyy setup weixin [--home PATH] [--account-id ID] [--secret NAME=VALUE] [--set NAME=VALUE] [--write-config]
anyy setup weixin login [--home PATH] [--base-url URL] [--secret NAME]

Use setup for the full interactive wizard, setup model for providers and the default model, setup aux for optional capabilities, and setup channels for messaging adapters. Channel setup writes secrets and, with --write-config, the matching channels.<name> config block.

Profile Commands

anyy profile list [--json]
anyy profile get NAME [--json]
anyy profile create NAME [--display-name NAME] [--json]
anyy profile use NAME [--json]
anyy profile delete NAME --force [--purge-secrets] [--json]

Profiles isolate home directories. delete requires --force, refuses the active/default profile, and requires --purge-secrets when profile secrets are present.

Role Commands

anyy role list [--home PATH] [--include-archived] [--json]
anyy role get [--home PATH] ROLE_ID [--json]
anyy role create [--home PATH] ROLE_ID [--display-name NAME] [--json]
anyy role update [--home PATH] ROLE_ID [--display-name NAME] [--soul-file PATH] [--json]
anyy role use [--home PATH] ROLE_ID [--json]
anyy role delete [--home PATH] ROLE_ID [--json]

Roles are persona layers inside one profile. They do not grant tools, secrets, or profile access by themselves.

Cron Commands

anyy cron list [--home PATH] [--include-disabled] [--role ROLE] [--workspace WORKSPACE] [--all-scopes] [--json]
anyy cron create [--home PATH] --name NAME --schedule SCHEDULE [--json]
anyy cron update [--home PATH] --id ID [--enable|--disable] [--schedule SCHEDULE] [--prompt TEXT] [--role ROLE] [--workspace WORKSPACE] [--all-scopes] [--json]
anyy cron delete [--home PATH] --id ID [--role ROLE] [--workspace WORKSPACE] [--all-scopes] [--json]

Cron commands manage scheduled prompts in the selected profile.

Channel Commands

anyy channels doctor CHANNEL [--home PATH] [--config PATH] [--json]
anyy channels reload [--home PATH] [--socket PATH] [--json]

Use doctor to validate one channel's config, secret references, live-smoke readiness, and webhook mode. Use reload after editing channel config while the gateway is running.

Skills Commands

anyy skills list [--home PATH] [--json]
anyy skills view [--home PATH] [--json] NAME [FILE_PATH]
anyy skills install [--home PATH] [--name NAME] [--force] [--all] [--rewrite-profile PROFILE] [--now] [--json] SOURCE
anyy skills uninstall [--home PATH] [--now] [--json] NAME
anyy skills reload [--home PATH] [--socket PATH] [--json]

Skills commands install, inspect, remove, and reload profile-local skills. --now asks the running gateway to reload immediately.

Memory Commands

anyy memory dream --dry-run [--home PATH] [--socket PATH] [--json]
anyy memory dream --execute --yes [--home PATH] [--socket PATH] [--json]

memory dream runs AutoDream through the resident gateway. --dry-run previews the proposed consolidation and writes nothing. --execute --yes first previews, then applies validated changes that may write USER.md and MEMORY.md.

This command requires a running gateway. Use --socket when the gateway uses a non-default socket. Use --json for the raw RPC response. The CLI currently exposes only memory dream; memory view and suggestion management are local or dashboard RPC surfaces, not shell subcommands.

MCP Commands

anyy mcp add SERVER_ID [--home PATH] --transport stdio --command CMD [--env KEY=VALUE] [--no-discover] [--args ARG...]
anyy mcp add SERVER_ID [--home PATH] --url URL [--transport http] [--auth oauth|header|none] [--header KEY=VALUE] [--enable --include a,b]
anyy mcp configure SERVER_ID [--home PATH] [--socket PATH] [--include a,b] [--enable] [--activate-toolset]
anyy mcp login SERVER_ID [--home PATH] [--json]
anyy mcp remove SERVER_ID [--home PATH] [--force]
anyy mcp enable SERVER_ID [--home PATH]
anyy mcp disable SERVER_ID [--home PATH]
anyy mcp set SERVER_ID KEY VALUE [--home PATH]
anyy mcp unset SERVER_ID KEY [--home PATH]
anyy mcp status [--home PATH] [--socket PATH] [--json]
anyy mcp list [--home PATH] [--socket PATH] [--json]
anyy mcp show SERVER_ID [--home PATH] [--socket PATH] [--json]
anyy mcp probe SERVER_ID [--home PATH] [--socket PATH] [--json]
anyy mcp test SERVER_ID [--home PATH] [--socket PATH]
anyy mcp reload [SERVER_ID] [--home PATH] [--socket PATH] [--json]
anyy mcp logs [SERVER_ID] [--home PATH] [--socket PATH] [--json]
anyy mcp serve [--home PATH] [--socket PATH]

For mcp add, put Anyy flags before --args or --; remaining values are treated as server arguments.

Browser Commands

anyy browser status [--home PATH] [--socket PATH] [--json]
anyy browser doctor [--home PATH] [--socket PATH] [--json]
anyy browser connect [--url URL] [--home PATH] [--socket PATH]
anyy browser disconnect [--home PATH] [--socket PATH]
anyy browser enable --url URL [--home PATH] [--socket PATH]
anyy browser disable [--home PATH] [--socket PATH]

Browser commands configure and inspect the optional browser tooling connection.

Computer Use Commands

anyy computer-use status [--home PATH] [--socket PATH] [--json]
anyy computer-use doctor [--home PATH] [--socket PATH] [--json]
anyy computer-use enable [--home PATH] [--socket PATH] [--command PATH] [--force]
anyy computer-use disable [--home PATH] [--socket PATH]

Computer-use support is optional and local-host scoped. Enable it only on a machine that can run the configured driver.

Heartbeat Commands

anyy heartbeat status [--home PATH] [--json]

heartbeat status reads the profile-local heartbeat record. Use it when status or doctor reports a missing, stale, disabled, or degraded heartbeat.

Maintenance Commands

anyy backup create [--home PATH] [--output PATH] [--include-secrets] [--json]
anyy backup list [--home PATH] [--json]
anyy update [--home PATH] [--version VERSION] [--base-url URL]
anyy update --compact [--home PATH] [--version VERSION] [--base-url URL]
anyy update --check [--home PATH] [--version VERSION] [--base-url URL]
anyy maintenance compact-state [--home PATH] (--output PATH | --replace) [--temp-dir PATH] [--json]
anyy maintenance checkpoint-state [--home PATH] [--journal-size-limit-bytes BYTES] [--json]
anyy maintenance prune-inactive-sessions [--home PATH] [--raw-days DAYS] [--limit N] [--now RFC3339] [--execute] [--json]
anyy maintenance cache-token-estimates [--home PATH] [--limit N] [--execute] [--json]
anyy maintenance migrate-lifecycle [--home PATH] [--raw-days DAYS] [--now RFC3339] [--temp-dir PATH] --execute [--json]
anyy uninstall --keep-data --yes [--home PATH]
anyy uninstall --full --yes [--home PATH]

Use backup commands before destructive maintenance. uninstall --keep-data removes code and command entrypoints while keeping data; uninstall --full removes the targeted data as well.