a13nDocs

命令参考

全部 shell 命令、选项和 TUI 斜杠命令。

用 shell 命令启动或管理 Harness UI;在 TUI 中使用斜杠命令。需要工作流说明而非语法速查时,从设置或TUI 使用开始。

Shell 调用

Terminal
a13n-harness-ui [GLOBAL OPTIONS] [COMMAND] [COMMAND OPTIONS]

省略 COMMAND 会打开 TUI。全局选项放在命令前;每层都可用 -h 或 --help。--version 打印版本后退出,不运行任何命令。帮助和版本不初始化 App、数据库、Model 或 Environment。

这些表展示命令行默认值;配置说明实际默认值。对话即根 Thread;--resume 接受其 Thread ID,不能与新对话的 Agent、Environment 或标题覆盖同用。

全局选项

参数类型 / 选项解析器默认值含义
--config路径未设置显式 Harness UI 配置 YAML(默认 ~/.a13n-harness-ui/a13n-harness-ui.yaml)。
--data-root路径未设置覆盖本地 Harness UI 数据根。
--resume文本未设置按 Thread ID 恢复已保存对话。
--agent文本未设置为新对话选择已配置 Agent。
--environment-modefull-control, sandbox未设置覆盖新对话的内置 Environment 模式。
--environment-profile文本未设置覆盖新对话的自定义 Environment 配置。
--displayconcise, detailed未设置只影响显示;覆盖 display.mode(默认 concise)。/mode 实时切换。
--no-update-check布尔值false本次启动跳过更新检测。
--version布尔值false显示版本并退出。

命令

全局选项放在这些子命令前。身份验证和插件命令修改本地存储;config 检查也会打开应用状态。

webui

运行一个前台 WebUI 服务器,使用内置浏览器资源。

参数类型 / 选项解析器默认值含义
--host文本"127.0.0.1"监听 IPv4 或 IPv6 地址。
--port整数 1..655358765监听 TCP 端口。
--apikey, --api-key文本未设置监听器 API 密钥;覆盖 A13N_HARNESS_UI_API_KEY(在 shell 参数中可见)。
--dangerous-skip-permissions, --dangerously-bypass-permission布尔值false只关闭 Web 身份验证,不改变 Agent 权限。
--share-computer / --no-share-computer布尔值true以服务器 OS 账户共享原生 Host Files、Git Changes 和 Terminal 面板,与 Agent 权限独立。

update

立即更新当前 uv tool 安装,不启动 TUI 或设置。

没有命令专用参数。

setup

交互式配置 Model、上下文预算和执行权限。

参数类型 / 选项解析器默认值含义
--advanced布尔值false还可选择上下文、推理、工具审查、subagent 和指令。

add agent

创建其他 Agent,不改变已有 Agent 或默认值。

参数类型 / 选项解析器默认值含义
--advanced布尔值false还可自定义推理、工具审查和指令。

add model

创建可复用 Model,不创建或修改 Agent。

参数类型 / 选项解析器默认值含义
--advanced布尔值false还可自定义订阅上下文和推理设置。

run

执行一次提示,不打开 TUI。

参数类型 / 选项解析器默认值含义
PROMPT文本必需必需位置参数
--resume文本未设置按 Thread ID 继续已保存对话。
--agent文本未设置新对话使用的 Agent。
--environment-modefull-control, sandbox未设置新对话使用的内置 Environment 模式。
--environment-profile文本未设置新对话使用的自定义 Environment 配置。
--title文本未设置新对话使用的标题。
--formattext, json"text"输出格式

config path

显示选中的配置和数据路径。

参数类型 / 选项解析器默认值含义
--formattext, json"text"输出格式

config validate

验证选中的源配置树。

参数类型 / 选项解析器默认值含义
--formattext, json"text"输出格式

config show

显示已接受配置。

参数类型 / 选项解析器默认值含义
--formattext, json"text"输出格式

config subagents

列出包提供的 subagent 和当前选择。

参数类型 / 选项解析器默认值含义
--formattext, json"text"输出格式

import subagents

预览或应用外部 subagent 导入。

参数类型 / 选项解析器默认值含义
--productclaude-code, cursor, codex必需要读取其 subagent 定义的产品。
--scopeuser, project必需读取用户级或项目级定义。
--project-root路径未设置project 范围读取的目录;该范围必需。
--user-home路径未设置user 范围读取的主目录(默认:你的主目录)。
--apply布尔值false应用所有就绪候选;省略则只预览。
--formattext, json"text"输出格式

plugin install

从 Git 仓库安装一个 Content Plugin。

参数类型 / 选项解析器默认值含义
REPOSITORY文本必需必需位置参数
--plugin文本未设置仓库包含多个插件时,指定插件 ID。
--ref文本未设置要安装的 Git 分支、标签或提交。
--formattext, json"text"输出格式

plugin list

列出已安装 Content Plugin 及其目录。

参数类型 / 选项解析器默认值含义
--formattext, json"text"输出格式

plugin uninstall

永久删除已安装 Content Plugin 目录,包括本地修改,不再确认。先备份编辑内容;重新安装不会恢复。

参数类型 / 选项解析器默认值含义
PLUGIN_ID文本必需必需位置参数
--formattext, json"text"输出格式

environment list

列出 Environment 模式和配置。

参数类型 / 选项解析器默认值含义
--formattext, json"text"输出格式

doctor

检查 App 和扩展健康状态。

参数类型 / 选项解析器默认值含义
--formattext, json"text"输出格式

auth status

显示 Model 身份验证状态。

参数类型 / 选项解析器默认值含义
PROVIDERchatgpt, codex, grok, copilot未设置可选位置参数
--formattext, json"text"输出格式

auth key list

列出已保存密钥引用,不返回密钥字节。

参数类型 / 选项解析器默认值含义
--formattext, json"text"输出格式

auth key set

通过不回显提示添加或替换密钥,绝不通过命令行传入密钥。

参数类型 / 选项解析器默认值含义
REFERENCE文本必需必需位置参数

auth key delete

确认后删除已保存密钥。后续使用该密钥解析 Model 可能失败。

参数类型 / 选项解析器默认值含义
REFERENCE文本必需必需位置参数
--yes布尔值false不显示提示,直接确认操作。

auth sources

列出受支持的已存账户来源,不公开凭据。目前只有 Copilot 支持来源选择。

参数类型 / 选项解析器默认值含义
PROVIDERchatgpt, codex, grok, copilot必需必需位置参数
--formattext, json"text"输出格式

auth select

显式替换此数据根中存储的账户和凭据来源绑定。使用 auth sources copilot 列出的登录;来源路径由 Host 解析,不在命令行提供。

参数类型 / 选项解析器默认值含义
PROVIDERchatgpt, codex, grok, copilot必需必需位置参数;目前仅 Copilot 支持选择
--sourcenative, copilot_cli_file必需凭据来源类型
--account文本必需选中的 GitHub 登录名
--formattext, json"text"输出格式

auth logout

移除选中的本地 Model 凭据。来源是共享 Copilot CLI 文件时,也会删除该文件中选中账户受支持的 token 字段,影响 Copilot CLI。其他账户保留;Host 不回退到其他来源。

参数类型 / 选项解析器默认值含义
PROVIDERchatgpt, codex, grok, copilot必需必需位置参数
--formattext, json"text"输出格式

login

为兼容的 Model 提供方完成身份验证。Copilot 只支持设备授权,默认公共 Copilot App 身份;订阅用户无需注册 OAuth App。权限和兼容性限制见模型与身份验证。

参数类型 / 选项解析器默认值含义
PROVIDERchatgpt, codex, grok, copilot必需必需位置参数
--allow-account-switch布尔值false允许登录替换此提供方已存储的其他账户。
--device-code, --browser布尔值true设备授权(默认;ChatGPT 使用粘贴回调 URL)或本地浏览器回调(仅 Codex 和 Grok)。
--formattext, json"text"输出格式

斜杠命令

在 TUI 输入框而非 shell 中输入。Tab 补全支持语法;/help 和 /? 显示原生帮助。没有 /setup、/login、/approve、/deny 或 /result 命令。决策使用对应类型的选择器。

“忙碌时可用”表示解析器允许在执行期间使用,不允许绕过待处理交互或操作不可用资源。/steer 要求根操作当前可接受引导。附件命令修改草稿。Agent 工作期间按 Enter,会把草稿文本和附件一同作为引导发送。见TUI 使用。

命令语法别名忙碌时可用用途
/help [command]/?是显示命令帮助和键盘快捷键。
/mode [concise|detailed]—是切换输出详细程度,不改变执行。
/theme [auto|dark|light]—是选择 TUI 主题。
/mouse [on|off]—是切换滚轮捕获;off 保留原生选择/复制。
/attach path—是为当前草稿附加文件或图像。
/paste-image—是显式读取剪贴板图像。
/recover—否恢复未发送提示。
/status—是显示 Model、上下文、Environment 和订阅用量。
/ps—是查看观测的后台进程及其最后报告状态。
/subagents [execution-id|next]—是查看本对话子级执行和保留输出。
/usage [details|subscription|reset]—是显示已记录 Thread 用量;subscription 显示 Codex 套餐限额;reset 确认后兑换一次 Codex 重置额度。
/goal task description—否朝目标工作,带完成审核和有上限的续接。
/steer message—是用补充输入引导活动 Run。
/import—否预览并可选启用继承父级的外部 subagent。
/agent [agent-id]—否切换 Agent,包括其 Model、指令和工具。
/model [model-id|default|defaults]—否覆盖 Model 直到你退出,并为 Project 记住该选择;default 清除覆盖和记住的选择;defaults 配置全局媒体理解,可 Save/Cancel。
/fast [on|off|ultrafast|reset]—否选择 Fast 或 Ultrafast 直到你退出,不保存配置。
/pro [on|off|reset]—否选择 Pro 推理模式;off 选择 Standard,reset 继承 Model。
/thinking [level]—否查看或改变后续轮次推理强度。
/environment [mode]—否查看或选择后续轮次的 Environment 模式(Full Control 或 Sandbox)。
/new—否开始新对话,保留全部已存历史。
/resume [thread-id]—否搜索、预览、命名已保存对话,或按 Thread ID 恢复。
/history—否浏览保留消息(Ctrl+T)。
/notes—否在显示预算内展示完整已保存笔记。
/config—否查找配置文件。
/review request-id—否针对所选续接查看待处理请求。
/cancel—是停止活动 Run。
/quit/exit是退出 TUI;已保存对话仍可恢复。

/thinking 打开所选 Model 支持的选项;命令补全使用相同列表。default 继承 Model 配置。按模型和适配器,显式选择可能包括 off、minimal、low、medium、high、xhigh 或 max。不支持的选项会被拒绝;未知模型仅提供 default 并解释原因。/environment 在支持时选择 full-control 或 sandbox。原生 /steer 保留整个尾随消息,不拆成 shell 词语。

重要操作与限制

  • auth key delete REFERENCE --yes 显式跳过删除确认,不使删除变得可逆。
  • plugin uninstall ID 立即删除安装文件和修改,不只是关闭来源。
  • update 请求安装,不再次确认。启动更新检查仍需在安装前确认。
  • import subagents 未提供 --apply 时只预览;导入文件不会自动加入每个 Agent。
  • 单次 run 不打开交互审批选择器;挂起/失败操作以非零状态退出。需要决策时以交互方式恢复。
  • webui --dangerous-skip-permissions 只改变 HTTP 身份验证,不改变 Agent 执行权限。暴露监听器前阅读 WebUI。

按任务查阅指南

本页目录