跳到主要内容

CLI 命令参考

按目标选择入口:想持续聊天直接运行 anyy,脚本发一轮用 chat,健康检查用 status/doctor,改变环境前用 profile/role 核对边界。下面的语法来自各命令解析器;不熟悉的入口仍可运行准确子命令的 --help。

参数先放对位置​

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

--profile、--profile-root、--role 和 --no-color 等调用选择器放在子命令前;默认 TUI 的 --home、--socket、--resume 直接放在 anyy 后;使用子命令时,其支持的 --home/--socket 必须放在该子命令后,放在前面会被拒绝。

参数用途
--profile NAME选择命名 Profile
--profile-root PATH指定 Profile 管理器的基础目录
--role ROLE为新会话选择初始 Role
--resume ID在 TUI 中直接恢复指定会话
--home PATH选择 TUI Home;或放在支持它的子命令后
--socket PATH选择 TUI Socket;或放在支持它的子命令后
--no-color关闭终端颜色
--version输出版本信息

每个命令的精确参数以本机 anyy COMMAND --help 为准。

发送一轮与排查环境​

anyy / --resume​

anyy
anyy --resume SESSION_ID

打开终端交互界面,可选恢复一个会话。

anyy chat​

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

通过已经运行的常驻 Gateway 发送一条新消息。--session 选择接收消息的已有会话;该会话忙碌时,输入会进入 follow-up 队列。--json 输出结构化结果,已启用工具直接执行。使用 anyy --resume ID 在 TUI 中打开已有会话;队列操作见会话。

成功时的 JSON 结果包含:

字段含义
session_id接收输入的会话
submission_id本次等待的原始已接纳输入
execution_id可被后续调用复用的 Session lane
agent_run_id提供本次回答的实际调用
execution_state观察到的 lane 状态,完成后通常为 idle
outcome该次调用的结果,succeeded 才表示成功
stop_reason完成或失败分类
assistant_text该次调用所记录结果消息中的可见回答

lane 为 idle 本身不代表成功。澄清暂停(suspended)、失败、终止、输入清除和超时均返回非零退出码,不打印中间回答。超时或调用方取消只终止观察。命令保持原 submission 身份,不用 Session 最新消息代替结果。详见命令行界面。

对话工具选择​

CLI 在默认 TUI 和 chat 入口接受以下参数。选择只属于目标 Session,不修改 Gateway 或 Profile 默认值。

参数含义
--tools LIST、-t LIST逗号分隔的名称/模式,或对默认选择使用完整的精确 +name/-name 修饰列表
--exclude-tools LIST、-xt LIST逗号分隔的排除名称/模式
--no-tools、-nt默认不激活任何工具
--no-builtin-tools、-nbt默认不激活内置工具,仍保留扩展的默认激活
anyy --tools '+codemode,+tool_search'
anyy chat --tools 'read,bash' --exclude-tools 'bash' "检查这个项目"
anyy chat --session SESSION_ID --tools '' "不使用工具回答"

普通模式支持 *。修饰列表不能混用普通名称,也不能包含通配修饰项。--tools '' 表示明确的空 allowlist,--exclude-tools '' 清空对应排除覆盖。参数须放在提示词前;可以放在 chat 前或后,命令内的列表替换对应全局列表。管理类子命令不接受这些对话参数。

两个禁用参数是独立的 Go 布尔 flags。内置工具情形使用 --no-builtin-tools,不支持 Pi 的 --no-tools builtin 写法;同时传入时 --no-tools 优先。Codemode 的 on/only 模式来自 Profile 设置,没有 --codemode-mode 参数。

新 Session 通过 session.new 接收 tool_selection。已有 Session 带显式参数时,先调用 session.tools.configure;活动工作、排队输入、接纳准备或摘要工作会导致 conflict,chat 不再提交新输入。不带覆盖参数连接热 Session 时,保留当前活动名称。原始冷恢复与分支导航使用所选分支的 canonical 声明,与 SDK 风格的显式初始选择不同。

工具恢复、资源重载和当前 Session 设置见会话。

本地 Prompt 诊断​

anyy prompt eval local --authorize-live

在隔离的临时会话中真实调用当前 Profile 的模型,可能产生费用。命令打印 模型回答、实际用量和耗时,并保存私有报告;--home PATH 选择 Profile, --output PATH 指定只写一次的报告路径。终端输出和报告都应保持私有。该诊断不启动渠道或 Cron,也不为模型 质量评分或证明 Pi 对齐完成。

anyy status​

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

查看 Profile、默认 Role、Home、时区、Gateway 监听与子系统摘要;模型/凭据配置用 anyy config,不要把状态摘要当在线模型测试。

anyy doctor​

anyy doctor [--home PATH] [--config PATH] [--json]

输出 Home/Profile、配置、时区、Gateway 监听、Cron、Heartbeat、MCP 和存储等检查。部分 MCP 项会探测连接;不会自动修复配置。

anyy config​

anyy config [--home PATH] [--config PATH]

在终端中显示配置概况:路径、provider/model、Endpoint 及凭据引用状态。它不修改配置,也不显示密钥明文。

先完成模型与功能设置​

anyy setup​

anyy setup [--home PATH]
anyy setup model [--home PATH]
anyy setup model fallback [--home PATH]
anyy setup channel [--home PATH]
anyy setup channel CHANNEL [--home PATH] \
[--set INPUT=VALUE] [--sensitive-fd INPUT=FD] \
[--external-locator-fd INPUT=FD]

运行完整/快速设置,或只配置模型、fallback、消息渠道。详见初始化设置。

anyy tools​

anyy tools [--home PATH] [--probe]
anyy tools list [--home PATH]
anyy tools websearch [--home PATH]
anyy tools image [--home PATH] [--probe]
anyy tools image understanding [--home PATH] [--probe]
anyy tools image generation [--home PATH] [--probe]
anyy tools video [understanding] [--home PATH] [--probe]
anyy tools voice [--home PATH] [--probe]
anyy tools voice tts [--home PATH] [--probe]
anyy tools voice stt [--home PATH] [--probe]

配置网页搜索、图像、视频和语音能力后端;--probe 在支持的流程中验证连接。

分开管理常驻助手和网页​

anyy gateway​

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

管理 resident Gateway 后台服务。

anyy dashboard​

anyy dashboard [--home PATH] [--socket PATH] [--listen ADDR] [--no-open]
anyy dashboard --status
anyy dashboard --stop

启动、查看或停止按需运行的 Dashboard sidecar。详见 Dashboard 概览。

渠道与配对​

anyy channel​

anyy channel doctor CHANNEL [--home PATH] [--socket PATH] [--json]
anyy channel pairing list [--channel CHANNEL] [--account ACCOUNT] [--all] [--json]
anyy channel pairing approve --request REQUEST
anyy channel pairing approve --prompt-code --channel CHANNEL --account ACCOUNT
anyy channel pairing approve --code-stdin --channel CHANNEL --account ACCOUNT
anyy channel pairing reject --request REQUEST
anyy channel pairing revoke --grant GRANT [--reason TEXT]
anyy channel reload [--home PATH] [--socket PATH] [--json]

诊断 Channel、处理 pairing request、撤销 grant,并让 Gateway 重载渠道配置。详见消息平台。

扩展流程和外部服务​

anyy skills​

anyy skills list [--home PATH] [--json]
anyy skills view [--home PATH] [--json] NAME [FILE_PATH]
anyy skills install [--home PATH] [--socket PATH] [--name NAME] [--force] [--now] [--json] ZIP_PATH
anyy skills uninstall [--home PATH] [--socket PATH] [--now] [--json] NAME
anyy skills rollback [--home PATH] [--socket PATH] [--revision REVISION_ID] [--now] [--json] NAME
anyy skills reload [--home PATH] [--socket PATH] [--json]

查看、安装、卸载、回退和重新加载 Skills。

anyy mcp​

anyy mcp add SERVER_ID [--home PATH] --transport stdio --command CMD [--cwd DIR] [--env KEY=VALUE] [--disable] [--args ARG...]
anyy mcp add SERVER_ID [--home PATH] --command CMD [--cwd DIR] [--exposure codemode|deferred|direct|hidden] [--tool-exposure JSON] [--description TEXT] [--args ARG...]
anyy mcp add SERVER_ID [--home PATH] --url URL [--transport http] [--auth JSON] [--oauth JSON] [--header KEY=VALUE] [--exposure codemode|deferred|direct|hidden]
anyy mcp add SERVER_ID [--home PATH] --preset filesystem [-- ARG...]
anyy mcp add SERVER_ID [--home PATH] --local --url URL [--oauth JSON] [--header KEY=VALUE]
anyy mcp add SERVER_ID [--home PATH] --local --command CMD [--cwd DIR] [--env KEY=VALUE] [--args ARG...]
anyy mcp configure SERVER_ID [--home PATH] [--socket PATH] [--exposure codemode|deferred|direct|hidden] [--enable]
anyy mcp configure SERVER_ID [--home PATH] [--socket PATH] [--tool-exposure JSON] [--description TEXT]
anyy mcp login SERVER_ID [--home PATH] [--socket PATH] [--timeout SECONDS] [--json]
anyy mcp logout SERVER_ID [--home PATH] [--socket PATH] [--json]
anyy mcp remove SERVER_ID [--home PATH] [--force]
anyy mcp remove SERVER_ID [--home PATH] --local
anyy mcp enable SERVER_ID [--home PATH] [--project]
anyy mcp disable SERVER_ID [--home PATH] [--project]
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 call SERVER.TOOL [--args JSON] [--home PATH] [--socket PATH] [--json]
anyy mcp call SERVER_ID TOOL_NAME [--args JSON] [--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]

管理 stdio/HTTP MCP Server、认证、可用工具、运行状态和直接调用。Transport 参数差异较大,添加前先运行 anyy mcp --help。

add 默认保存启用的 lazy Server,--disable 可停用。配置使用工具暴露与有序覆盖,不需要工具选择或成功 Probe。RPC tool_exposure 使用有序 JSON 对象字符串;Probe 返回单一 tools 库存及 exposure/offered 事实。

configure --exposure/--enable 把设置保存到当前定义来源或已有项目覆盖;configure --description/--tool-exposure 及通用 set/unset 则编辑原始 Profile 定义。一次 configure 混用两类参数会被拒绝,应分开执行;编辑前可用 show 查看来源。

add --cwd DIR 只用于 stdio 服务。添加和通用 set SERVER_ID cwd VALUE 保留输入的相对路径、绝对路径或开头的用户目录写法;cwd 的相对基准是常驻 Profile 的规范 Workspace。

普通 MCP 配置值写入会保留输入字符串及其表达式,不按敏感字段名自动保存为 Secret。Profile 中明确填写的 env:、secret:、file: 引用仍使用各自的解析规则。

--project 只用于启用/停用尚无覆盖的 Profile 服务,写入仅含启用状态的项目覆盖。--local(也可写作 -l)只用于添加/移除,目标为 Profile 规范 Workspace 的 .anyy/mcp.json。本地添加会替换同名条目,无须 --force;本地移除保留 Profile 配置和已保存授权。两者都不立即重载运行条目;在 Profile 配置中添加/移除 MCP 服务器定义,保留既有确认和凭据处理。

reload 按已加载配置重新连接,不重新读取文件;启动或空闲会话的 session.reload RPC 会重新读取 Profile 和项目文件。登录的 --timeout 默认 300 秒,只限制授权阶段。详见 MCP 配置。

logout 清除该服务选中的本地 OAuth 授权及支持的客户端材料,保留服务定义;在线走常驻运行时,离线须取得 Profile 独占所有权。

anyy mcp serve 可以把 Anyy 接入其他 MCP 客户端。messages_send 的结果始终属于原 submission;它可以报告澄清暂停,但不把暂停当成最终答案。字段与等待接口见 MCP 对话结果/API 参考。

安排定时工作​

anyy cron​

anyy cron list [--home PATH] [--include-disabled] [--role ROLE] [--workspace WORKSPACE] [--all-scopes] [--json]
anyy cron create [--home PATH] --name NAME --schedule SCHEDULE --prompt TEXT \
[--kind agent|skill|notify] [--skills LIST] [--role ROLE] [--workspace WORKSPACE] \
[--delivery-target TARGET] [--delivery-channel CHANNEL] [--toolsets LIST] [--json]
anyy cron create [--home PATH] --name NAME --schedule SCHEDULE --kind script --script NAME \
[--workdir PATH] [--role ROLE] [--workspace WORKSPACE] [--delivery-target TARGET] [--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]

create 支持 agent、skill、script、notify。未写 kind 时,有 script 参数就选脚本,否则默认 agent;agent、skill、notify 任务需要 prompt,脚本任务需要 script。delivery-target 可选 gateway、origin、current_user_default、none,能否使用还取决于投递条件。运行沿用保存的 Role、Workspace、任务内容与路由。

anyy heartbeat​

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

查看常驻 Heartbeat 状态。

操作哪套数据、使用哪个身份​

anyy profile​

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]

profile use 改后续命令的粘性选择,不搬移正在运行的 Dashboard。删除须带 force;包含 Secrets 还须 purge-secrets。目标必须非 default、非活动选择并停止运行,操作清除整个 Home。

anyy role​

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]

Role 只管理 Profile 内的身份与 Soul;不切换工具或 Codemode。删除实际归档记录、保留 Soul,include-archived 可查归档。default 和仍有引用的 Role 受限制。

保护数据及更新程序​

anyy backup​

anyy backup create [--home PATH] [--output PATH] [--include-secrets] [--json]
anyy backup restore --archive PATH --target-home PATH [--json]
anyy backup list [--home PATH] [--json]

备份一次针对所选 Profile。--include-secrets 只负责额外纳入托管的 secrets/、mcp/oauth/ 目录,不扫描或脱敏所有文件;即使不加参数,配置和 Workspace 文件中的内联凭据仍可能进入归档。每份归档都应保持私密、按敏感数据保护,边界见备份与恢复。restore 的 target-home 必须不存在;没有覆盖恢复或任意目录注册命令。恢复后先 status/doctor 验证,再选择使用。

anyy maintenance​

anyy maintenance compact-state [--home PATH] (--output PATH | --replace) [--temp-dir PATH] [--json]
anyy maintenance checkpoint-state [--home PATH] [--json]
anyy maintenance cache-token-estimates [--home PATH] [--limit N] [--execute] [--json]

这些操作维护数据库,不是上下文摘要。compact-state 必须二选一 output 或 replace;替换、checkpoint 和 execute 估算补全要求离线所有权。估算默认预览,只补缺失正数;操作前保留有效备份。

anyy update​

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]

检查或更新原生 resident 安装。详见更新与卸载。

anyy uninstall​

anyy uninstall
anyy uninstall --keep-data --yes
anyy uninstall --full --yes
anyy uninstall --home PATH --keep-data --yes

卸载原生 resident 安装。使用 --yes(-y)前必须选择 --keep-data 或 --full,两者不能同用。--home PATH 选择安装 Home;--full 同时删除范围内全部 Anyy 数据,执行前先备份。