CLI 命令参考

OpenClacky 提供两个 CLI 命令:openclacky agent(默认)和 openclacky server


openclacky agent

在终端中启动交互式 Agent 会话。这是默认命令——直接运行 clacky 等同于 openclacky agent

openclacky [agent] [参数]

参数说明

参数 默认值 说明
--mode confirm_safes 权限模式(见下文)
--theme hacker 界面风格:hackerminimal
--path 当前目录 项目目录
--agent coding Agent 配置文件:codinggeneral 或自定义名称
-m, --message 非交互模式:发送此消息后退出
-i, --image 附加图片文件路径(配合 -m 使用)
-c, --continue 继续当前目录最近一次会话
-l, --list 列出最近的会话
-a, --attach 按编号或会话 ID 前缀附加到指定会话
--json false 以 NDJSON 格式输出到 stdout(适合脚本/管道)
-v, --verbose false 显示详细输出

权限模式

模式 行为
confirm_safes 自动批准安全的只读操作,写入和 shell 命令需要确认(默认)
auto_approve 自动执行所有工具,无需确认。谨慎使用。
confirm_all 自动批准文件/shell 工具,但交互式提示会暂停等待

Agent 配置文件

配置文件 说明
coding 完整的编码 Agent,包含所有开发工具(默认)
general 通用助手,工具集更轻量
自定义 ~/.clacky/agents/<name>/ 中定义的任意配置文件

使用示例

# 在当前目录启动新会话
clacky

# 指定目录,自动批准所有操作
openclacky --path /path/to/project --mode auto_approve

# 非交互模式:发送一条消息后退出
openclacky -m "给这个项目加一个 README"

# 非交互模式,附带图片
openclacky -m "这个截图里有什么?" -i /path/to/image.png

# 继续最近一次会话
openclacky -c

# 列出最近会话,然后附加到第二个
openclacky -l
openclacky -a 2

# 通过会话 ID 前缀附加
openclacky -a b6682a87

# 以 NDJSON 格式输出(适合脚本)
openclacky --json -m "运行测试套件"

openclacky server

启动 Web UI 服务器。完整说明见 Web UI 服务器

openclacky server [参数]

参数说明

参数 默认值 说明
--host 127.0.0.1 绑定地址
--port 7070 监听端口

使用示例

# 默认地址启动
openclacky server

# 监听所有接口,自定义端口
openclacky server --host 0.0.0.0 --port 8080

配置文件

CLI 从 ~/.clacky/config.yml 读取配置。API 密钥和模型设置也可以通过环境变量提供。详见 模型与 API 配置