第27章 参考指南

CLI 参考 Ante 可以以交互式 TUI、一次性无头命令、常驻协议服务器或频道网关的方式运行。 ante [OPTIONS] [COMMAND]
子命令​ 命令说明ante启动交互式 TUI。若提供 -p / --prompt，则以无头模式运行。ante auth管理提供商登录，无需启动 agent 会话。ante serve通过 stdio、Unix socket 或 WebSocket 运行常驻协议服务器。ante gateway运行 Slack / Discord 频道网关。ante update检查最新 Ante 版本，如有则安装。ante offline管理离线模式使用的本地推理引擎。ante rage收集脱敏后的 bug 报告包（日志 + 环境信息），分享给 Ante 团队。ante catalog以 JSON 格式输出已加载的提供商目录。ante doctor执行启动自检并报告各启动阶段的耗时。ante 运行外部 ante- 应用。 全局选项​ --profile 指定已有的 ~/.ante/.settings.json 作为整个进程的配置文件（读取和写入均适用）。它可以出现在任意子命令之前或之后，效果等同于环境变量 ANTE_PROFILE。如果 profile 不存在，会发出警告并回退到 ~/.ante/settings.json，而不会新建文件。内置的 bare profile 首次使用时会生成真实文件，并禁用 skills、MCP 服务器、会话保存、自动记忆和环境感知 UI 功能。 ante --profile work
ante update --profile work
ANTE_PROFILE=work ante doctor
ante​ ante [OPTIONS]
不使用 --prompt 参数时，Ante 会启动交互式 TUI；加上 --prompt 后，则执行单次无头任务并立即退出。TUI 要求标准输出连接到终端。若将其重定向或通过管道传输（如 ante > log.txt），系统会预先拒绝该操作，并提示使用无头模式，而不是等到后期因查询光标位置而失败。 标志说明 -m, --model ：覆盖默认模型名称。 --provider ：按目录中的名称覆盖 API 提供商。 --effort ：覆盖本次运行的模型 effort 级别：min、low、medium、high、xhigh 或 max。 --yolo：跳过本次会话的工具审批提示。 --fullscreen：在备用屏幕上启动 TUI 聊天，并让 Ante 管理本次运行的滚动回显。不会持久化 render_mode 设置，且在无头模式下被忽略。 --permission-mode ：覆盖本次运行的权限模式：strict、auto 或 yolo。与 --yolo 冲突。无头运行时会遵循此覆盖设置，并拒绝需要交互式审批的调用。 --system-prompt ：完全替换默认系统提示词。与 --system-prompt-file 冲突。可通过 system_prompt 设置持久化默认值。 --system-prompt-file ：从 UTF-8 文件中读取替换用的系统提示词。与 --system-prompt 冲突。 --append-system-prompt ：向默认系统提示词追加内容。可通过 append_system_prompt 设置持久化默认值。 --short-prompt：本次运行使用精简提示词集合，包括简化的系统提示词和更短的内建工具描述。可通过 short_prompt 设置持久化默认值。 --skills：为本次运行加载 skills，覆盖 skills 设置。与 --no-skills 冲突。 --no-skills：本次运行跳过 skill 发现，覆盖 skills 设置。模型不会被告知任何 skills，也无法将其作为斜杠命令使用。 --include-skills ：为本会话添加确切的 skill 名称，替换 include_skills 设置。可传入逗号分隔的值或重复使用此标志。当 --no-skills 或 "skills": false 生效时，不会重新启用 skills。 --exclude-skills ：从本会话中移除确切的 skill 名称，替换 exclude_skills 设置。可传入逗号分隔的值或重复使用此标志；排除项优先于包含项。 --enable-auto-memory：为本次运行启用 auto-memory，覆盖 auto_memory 设置。与 --disable-auto-memory 冲突。 --disable-auto-memory：为本次运行禁用 auto-memory，覆盖 auto_memory 设置。与 --enable-auto-memory 冲突。 --tools ：用指定的工具集完全替换默认工具集。可传入逗号分隔的值或重复使用此标志；空格分隔的列表会被拒绝。覆盖 tools 设置。旧的 --allowed-tools 名称已移除。 --include-tools ：在默认工具集基础上添加工具，或在 --tools 指定的基础集上添加。可传入逗号分隔的值或重复使用此标志。 --exclude-tools ：在应用 --tools 和 --include-tools 后移除指定工具。可传入逗号分隔的值或重复使用此标志。已弃用的 --disallowed-tools 别名仍被接受。 --output-format ：无头输出格式：json、human 或 minimal。默认为 minimal。 -p, --prompt ：无头模式下运行的提示词。支持通过管道传入标准输入。 --check：无头任务完成后运行验证流程。 -r, --resume [SESSION_ID]：按 ID 恢复会话，若省略 ID 则为当前目录打开交互式会话选择器。无头运行必须提供 ID。 --session-save：保存会话记录和可恢复快照，覆盖 session_save 设置。与 --no-session-save 冲突。 --no-session-save：不保存会话记录或可恢复快照，覆盖 session_save 设置。与 --resume 冲突。 --offline-model ：用于离线推理的本地 GGUF 模型文件路径。 -h, --help：打印命令帮助。 -V, --version：打印 Ante 版本。 表格中的会话标志用于配置默认 TUI/无头运行。若与子命令同时提供，系统会将其视为错误而非静默忽略；全局 --profile 标志除外。 示例 ante
ante -p "说明此项目的功能"
git diff | ante -p "审查此 diff 中的 bug"
ante --provider openai --model gpt-6.1-sol -p "重构数据库模块"
ante --effort max -p "查找调度器中的竞态条件"
ante --profile work
ante --profile bare -p "审查此仓库"
ante --resume ses_01ARZ3NDEKTSV4RRFFQ69G5FAV -p "现在添加测试"
ante -p "总结此仓库" --enable-auto-memory
恢复会话时，已保存的系统提示词和提示模式优先于 --system-prompt、--system-prompt-file、--append-system-prompt 和 --short-prompt。这些标志仅适用于本次启动的新会话，包括后续的 /clear 操作。 ante auth​ ante auth login [PROVIDER] [OPTIONS]
在不启动 TUI 会话的情况下登录 OAuth 提供商。目前支持的提供商是 antix，当省略 [PROVIDER] 时，它是默认值。 标志 说明 --force 即使已存在存储的凭据，也重新运行浏览器登录。 --no-browser 打印授权 URL，而不是打开浏览器。 -h, --help 打印命令帮助。 示例​ ante auth login
ante auth login antix --force
ante auth login --no-browser
ante serve​ ante serve [OPTIONS]
Server 模式默认通过 stdin/stdout 暴露 Ante 协议，提供 --sock 参数时通过 Unix domain socket，提供 --ws 参数时通过 WebSocket。 参数说明--stdio在 stdin/stdout 上提供 JSONL 协议，这是默认传输方式。三个传输参数互斥，只能选一个。--sock [PATH]通过 Unix domain socket 提供协议服务。不指定路径时，默认使用 Ante 主目录下的 run/serve.sock。--ws 在指定的回环地址上通过 WebSocket 提供协议服务。--offline-model 启动时加载本地 GGUF 模型，用于离线模式。-h, --help打印命令帮助。 note serve 与会话无关，因此不接受会话相关参数（--model、--provider、--yolo、--system-prompt、--tools 等）。连接的客户端通过协议按会话配置这些选项。全局的 --profile 参数仍然可用，用于指定服务进程使用的设置文件。 caution --ws 要求设置非空的 ANTE_SERVE_TOKEN，且只接受回环地址（127.0.0.0/8、::1）。客户端必须在 WebSocket 升级请求中发送 Authorization: Bearer ；令牌缺失或错误会返回 HTTP 401，握手超过 10 秒超时。非回环地址（如 0.0.0.0:8080）会在监听器绑定前被直接拒绝。如果需要从其他机器访问守护进程，请使用 SSH 隧道或带认证的 TLS 反向代理（wss://）。 note 同一时刻一个 socket 只能由一个主机占用。--sock 会在 socket 旁边对一个 .lock 文件加排他锁，因此同一个路径上的第二个 ante serve --sock 会拒绝启动，且不会影响正在运行的主机的 socket。崩溃主机遗留的 socket 文件不带锁，下次启动时会被直接替换。每个客户端连接驱动各自的会话。客户端发送 Shutdown 只会结束该连接——主机继续监听，收到 SIGINT 或 SIGTERM 时才退出。 示例​ ante serve
ante serve --sock # ~/.ante/run/serve.sock
ante serve --sock /tmp/ante.sock
ANTE_SERVE_TOKEN="your-secret-token" ante serve --ws 127.0.0.1:8080
ante gateway​ ante gateway [OPTIONS]
从 v0.2.2 起，该命令将请求分发给独立安装的 ante-gateway 应用，并原样传递其余参数。Gateway 通过 SDK 连接 Ante 主机，并使用其 channels 配置来管理 Slack 和 Discord。请参见 Gateway 模式 章节了解安装方法；若可执行文件缺失，程序将以状态码 127 退出。 Flag默认值描述--config ~/.ante/channels.jsonchannels 配置文件的路径。--connect unix:~/.ante/run/serve.sockAnte 主机端点：unix:、ws://、wss:// 或 stdio。可通过 ante serve --sock 启动主机。--model —请求使用的模型（否则使用主机配置）。--provider —请求使用的供应商（否则由主机解析）。--output-format minimalGateway 标准输出格式：json、human 或 minimal。-h, --help-打印命令帮助。 示例 ante gateway ante gateway --connect unix:/tmp/ante.sock ante gateway --provider anthropic --model claude-sonnet-5-5 ante gateway --config ./channels.json --output-format human ante update ante update [OPTIONS] [CHANNEL] update 命令会检查是否有更新的 Ante 版本，若有则进行安装。若不传参数，则遵循当前生效设置文件中的 channel（默认为 stable）；可通过全局 --profile 标志选择指定的设置文件。传入 channel —— 无论是作为位置参数还是通过 --channel —— 仅在本次运行中覆盖被跟踪的 channel。完整的 channel 列表请参见 更新与通道。 参数描述[CHANNEL]用于更新的发布 channel（stable 或 nightly）。latest 作为 stable 的遗留别名被接受。与 --channel 和 --version 冲突。 Flag描述--channel 用于更新的发布 channel。等价于位置参数形式。--version 安装精确版本而非该 channel 的最新版本。接受带或不带前导 v 的值，例如 v0.2.8 或 0.2.8。与 channel 参数冲突。-h, --help打印命令帮助。 示例 ante update ante update nightly ante update --channel stable ante update --version v0.2.8 ante --profile work update ante offline ante offline 管理离线模式所用的本地推理引擎，无需启动会话。 子命令说明：install 下载并安装 Ante 指定的 llama.cpp 构建版本。 install 会将引擎收敛到指定构建版本：若当前已安装该指定版本，则不做任何操作；否则，若当前为其他版本或未记录版本，则予以替换，并在执行过程中输出进度信息。其安装的构建版本与 TUI 中 /offline-mode 对话框所使用的相同，且经过校验和验证。在没有该引擎的机器上运行离线模型会快速失败，并指向此处。 示例 ante offline install ante rage ante rage [OPTIONS] # 第27章 Reference 当出现问题时，ante rage 会把 Ante 团队调查所需的上下文信息打包成一个可分享的归档文件，你可以把它附加到 GitHub issue 上。默认情况下，它会生成 ./ante-rage-.tar.gz 并打印一份简要摘要。所有内容都不会上传——归档会一直保留在本地，直到你主动分享。 使用 --no-compress 时，最终报告是一个目录，位于 ./ante-rage- 或指定的 --output 路径。两种格式都不会覆盖已存在的输出，且父目录必须已存在。如果压缩失败，Ante 会在归档路径的基础上加上 .uncompressed 后缀，写入一个报告目录。 在写入任何内容之前，敏感信息都会先被脱敏。API 密钥和 OAuth token 只报告存在与否（绝不包含其值），URL 中嵌入的凭证和已知格式的 token 会被遮蔽，对话记录和 system prompt 会被排除，~/.ante/auth/*.json 和 channels.json 则永远不会被包含。 归档包含以下内容： FileContents report.md：Ante 版本、操作系统/架构、shell、git 分支、解析出的模型/提供商、一张提供商认证状态表（存在/不存在）、telemetry 安装 ID（如果存在），以及脱敏说明。 env.txt：与 Ante 相关的环境变量。安全值原样显示；已知敏感项只显示 / 。 settings.redacted.json：~/.ante/settings.json 去除敏感信息后的副本（MCP 服务器凭证以及自定义 system_prompt / append_system_prompt 文本会被剔除）。 catalog.redacted.json：~/.ante/catalog.json 去除敏感信息后的副本，仅在存在自定义 catalog 时才包含。 logs/：最近的应用日志和崩溃日志，经过筛选和清理；每份副本以日期为前缀（-）。DEBUG/TRACE 行会被丢弃，因此请求体不会进入归档。 如果项目设置文件适用于你收集信息的目录，其 .ante/settings.json 也会被包含，并采用与用户设置文件相同的脱敏方式——这样归档就能反映实际生效的设置。 默认收集最新的日志，最多 10 个文件或 10 MB（崩溃日志始终优先）。也可以用 --since 按时间窗口收集范围内的所有日志。 FlagDescription --output ：精确的输出路径：通常为归档文件，使用 --no-compress 时为报告目录。默认分别为 ./ante-rage-.tar.gz 或 ./ante-rage-。 --no-compress：将最终报告写成目录而非 .tar.gz。 --verbose-logs：同时包含 DEBUG/TRACE 日志行。对话记录和 system prompt 仍然会被排除。 --since ：收集时间窗口内修改过的所有日志，忽略文件数量和大小限制。支持 d、h、m 或纯数字表示天数（例如 7d、48h、90m、2）。 -h, --help：打印命令帮助。 示例​ ante rage
ante rage --output ./ante-bug.tar.gz
ante rage --since 7d
ante rage --no-compress
ante catalog​ ante catalog
将合并后的 Provider 目录（内置预设加 ~/.ante/catalog.json）以 JSON 格式输出到 stdout，内容为单一的 providers 数组，并按目录顺序排列。每个 Provider 都会嵌入其首选模型及用户配置的模型覆盖，因此该输出可作为面向消费者的发布视图；它不是配置文件结构，也不能直接反向写入 ~/.ante/catalog.json。关于跳过目录条目的警告会输出到 stderr，确保 stdout 保持为可供 jq 管道处理的纯 JSON 文档。配置文件结构详见 Catalog Reference。 Examples​ ante catalog
ante catalog | jq '.providers[].id'
ante doctor​ ante doctor
启动与真实启动相同的运行时——加载合并目录、启动守护进程会话并渲染第一个 TUI 帧——然后输出包含各阶段耗时的就绪报告。可用于确认 Ante 安装配置正确，或作为 CI 冒烟测试（检查 Ante 是否启动、首帧是否渲染成功）。 该命令无需 TTY 和 API 密钥：MCP 预热被跳过，会话仅靠目录即可达到就绪状态。报告列出五项检查——home（Ante 主目录和输入历史可写）、project（适用于当前目录的项目设置文件，或未找到任何文件）、catalog（Provider/模型数量）、session（解析后的 Provider/模型）以及 first frame（无头渲染）——最后显示总耗时。警告（如未认证 Provider、跳过的目录条目、settings.json 解析提示、或项目设置文件中的键被移除等）会在表格下方列出。若任何硬性检查失败（包括 Ante 主目录不可写），doctor 返回非零退出码，便于在脚本中使用。 Examples​ ante doctor
ante doctor || echo "ante is not healthy"
External applications​ 无法识别的命令名会分派给名为 ante- 的可执行文件，遵循与 git 子命令相同的约定： # Runs ~/.ante/bin/ante-deploy or ante-deploy from PATH
ante deploy --target production
Ante 在 PATH 之前优先搜索 `~/.ante/bin`，若 PATH 中缺失则回退至 `~/.cargo/bin`。剩余参数原样透传，并镜像应用的退出状态。内置子命令始终优先，因此外部可执行文件无法覆盖 `ante update` 等内置命令。若未找到可执行文件，Ante 报告退出状态 127，并针对可能的拼写错误提示同名的内置命令。 外部应用接收环境变量：`ANTE`（Ante 二进制的绝对路径）、`ANTE_APP`（解析后的应用名称），以及在激活状态下选定的 `ANTE_PROFILE`。与 help 和 usage 错误一样，分发过程在 Ante 启动运行时、日志、遥测或崩溃钩子之前完成。 输出格式 minimal 仅输出 agent 消息、信息和错误。human 以人类可读格式输出所有事件。json 以 JSON lines 格式输出事件，供机器处理。 相关页面 TUI Mode Headless Mode Server Mode Gateway Mode Tools Reference