跳到正文
heng-agent v0.5.0
Esc
使用指南目录

参考

命令行参数

heng-agent 启动时能带的全部参数:选服务商与模型、权限模式、工作目录与数据目录、接着上次的会话、工作树、脚本模式 -p 与输出格式、放行与禁止规则、ACP,以及 heng-agent upgrade。

预计用时
查阅
适用版本
v0.5.0 及以上

选服务商与模型

参数 作用
--provider 名字 用哪个服务商配置档;不写用配置文件的 default
--model 名字 临时覆盖配置档的模型名
--base-url 地址 临时覆盖配置档的地址
--list-providers 列出可用的服务商配置档、默认用哪个、密钥是否已设置

详见 服务商与配置文件。

权限与目录

参数 作用
--permission-mode ask 手动确认(默认):改文件、跑命令前都问你
--permission-mode accept-edits 自动改文件:改文件不问,跑命令还问
--permission-mode plan 计划模式:只读代码,交出计划等你批准
--permission-mode auto 全部放行:什么都不问(只在 CI、一次性沙箱等可信环境用;仍不能读写工作目录以外)
--workdir 目录 工作目录,默认当前目录;文件读写与命令都限定在这里
--home 目录 用户级目录(配置、会话、历史),默认正式版 ~/.heng-agent;也可用环境变量 HENG_AGENT_HOME
-w 名字(--worktree) 在独立的 git 工作树里工作(分支 heng/名字),见 git 工作树隔离

会话

参数 作用
-c(--continue) 接着这个目录最近的会话聊
--resume [id](-r) 不带 id 同 -c;带 id(或前缀)接指定的会话
--sessions 列出这个目录的会话
heng-agent "要做的事" 进入交互界面并先发出这句话

详见 会话:恢复、命名、导出。

脚本模式与编辑器

参数 作用
-p "任务"(--print) 执行这一个任务后退出;管道内容附在后面,只写 -p 就把管道内容当问题
--output-format text|json|stream-json -p 的输出:普通文字 / 最后一个 JSON 对象 / 每个事件一行 JSON
--allowed-tools "规则,规则" 这次运行额外允许的规则,写法同 /permissions
--disallowed-tools "规则" 这次运行额外拒绝的规则
--acp ACP 模式:让编辑器通过标准输入输出驱动它,见 在编辑器里用

详见 脚本模式 -p。

版本与升级

命令 作用
heng-agent --version 显示版本号(正式版不带 -dev)
heng-agent upgrade 升级到最新版。Windows 上会开一个新窗口,等 heng-agent 退出后再升级

做完是这样

需要的参数在上面几张表里都能找到;拿不准时 heng-agent --help 列出当前版本支持的全部参数。

最后更新: