CLI 命令
lody 同时扮演两种角色:
- 通过
lody start或lody daemon start启动的本地运行进程 - 用于管理 workspace、GitHub 仓库、session、machine、agent-config 的一次性命令行工具
如果你刚开始使用 Lody,建议先阅读快速开始、会话、 代理配置 和 CLI 类型支持。
如何查看参数
CLI 内置的 --help 是参数列表和位置参数的权威来源。
lody --help
lody session --help
lody session create --help
lody agent-config update --help可以按下面的规律查任意命令:
| 范围 | 命令 |
|---|---|
| 顶级总览 | lody --help |
| 命令分组 | lody <group> --help |
| 具体子命令 | lody <group> <subcommand> --help |
命令总览
| 命令分组 | 用途 | 帮助命令 | 文档位置 |
|---|---|---|---|
lody / login / logout / start | 登录、查看 CLI、前台启动本地运行进程 | lody --help | 基础命令 |
daemon | 后台启动、停止、查看 Lody daemon 和日志 | lody daemon --help | Daemon 模式 |
workspace | 查询可访问的 workspace ID 与 slug | lody workspace --help | Workspace 命令 |
github | 列出某个 workspace 中已经链接的 GitHub 仓库 | lody github --help | GitHub 命令 |
project | 管理本地项目注册 | lody project --help | Project 命令 |
session | 创建、继续、查看、归档、恢复、删除 session | lody session --help | Session 命令 |
machine | 查看 workspace 中已注册的机器 | lody machine --help | Machine 命令 |
agent-config | 管理 agent config,并刷新运行时能力 | lody agent-config --help | Agent Config 命令 |
基础命令
| 命令 | 作用 | 帮助命令 |
|---|---|---|
lody | 查看顶级帮助和全部命令 | lody --help |
lody login | 登录并注册当前机器 | lody login --help |
lody logout | 清理本地登录凭据 | lody logout --help |
lody start | 在当前终端前台运行 Lody CLI | lody start --help |
以下命令会直接与本地运行进程通信,因此通常需要先执行 lody start,或使用 lody daemon start 在后台保持运行:
lody session createlody session chatlody session cancellody agent-config refresh-capabilities
非交互式登录 --auth
lody login 默认会打开浏览器走 Device Authorization 授权流程。在无头环境(CI runner、远程服务器、容器等) 可以改为使用预先生成的 CLI Token 登录:
lody login --auth <token>
lody start --auth <token> # 一步完成登录并启动--auth <token>使用的是在 桌面端或 Web 端 设置 → 账户 → CLI Token 里生成的 CLI Token。 点击 Create token,填写备注(例如CI runner、home server),然后在关闭弹窗前把 token 复制出来—— token 只会展示一次。- Token 随时可以在同一个面板里吊销,吊销后,使用该 token 的所有 CLI 都会立即失效。
--auth与交互式登录一样支持--machine-name <name>,可以覆盖默认的 hostname。- 如果
lody login不传--auth,会回退到交互式的 Device Authorization 流程;如果lody start在没有已有 session 的环境里省略--auth,runtime 会提示你单独登录。
请把 token 妥善保管(例如放在 secrets manager 或 LODY_AUTH 环境变量里)。它和交互式登录拥有相同的 workspace 访问权限。
Daemon 模式
lody daemon start 会在后台启动 Lody CLI,并由 daemon 维护运行状态。它适合长期连接桌面端、Web 端和移动端,不需要一直保留一个终端窗口。
| 命令 | 作用 |
|---|---|
lody daemon start | 启动后台 daemon |
lody daemon status | 查看当前运行状态、机器和连接信息 |
lody daemon logs | 查看最近日志,默认显示最近 50 行 |
lody daemon stop | 停止后台 daemon |
lody daemon restart | 先停止(若在运行),再重新启动 |
常用示例:
lody daemon start
lody daemon status
lody daemon logs --lines 100
lody daemon restart
lody daemon stopDaemon 的日志会写入 ~/.lody/logs。如果你正在排查启动问题,可以先用 lody daemon logs 查看日志;如果希望直接在当前终端看到实时输出,可以临时使用 lody start。
Workspace 命令
当你需要精确的 workspace ID 或 slug 时,先用 workspace 命令查询。
| 命令 | 作用 | 帮助命令 |
|---|---|---|
lody workspace list | 列出当前账号可访问的 workspace | lody workspace list --help |
workspace list
lody workspace list 默认输出 ID、Name、Slug 三列,可直接用于后续 --workspace <idOrSlug> 参数。
lody workspace list
lody workspace list --jsonGitHub 命令
GitHub 命令用于查看某个 workspace 当前已经从设置页 GitHub 集成中链接进来的仓库。
| 命令 | 作用 | 帮助命令 |
|---|---|---|
lody github list | 列出已经链接到某个 workspace 的仓库 | lody github list --help |
github list
lody github list 只显示已经添加到当前 workspace 的仓库,不会把 GitHub App 能访问但尚未加入 workspace 的仓库一起列出来。
lody github list --workspace my-team
lody github list --workspace my-team --json常用参数:
--workspace <idOrSlug>:指定目标 workspace- 默认输出为人类可读表格,包含仓库 ID、完整仓库名和可见性
--json:输出结构化仓库数据,方便自动化处理
精确参数:
lody github list --helpProject 命令
Project 命令用于管理本地项目注册。注册之后,session 创建时可以用 --local-project <id|name|path> 选择。
| 命令 | 作用 | 帮助命令 |
|---|---|---|
lody project add [path] | 注册一个本地项目目录 | lody project add --help |
lody project list | 列出已注册的本地项目 | lody project list --help |
lody project delete | 删除已注册的本地项目 | lody project delete --help |
精确参数请直接查看:
lody project add --help
lody project list --help
lody project delete --helpSession 命令
Session 命令是 CLI 中最核心的一组工作流命令。
使用前建议先了解:
session create、session chat、session cancel需要当前机器上有lody start或lody daemon start正在运行session list、history、show、rename、archive、restore、delete只要求已登录且有 workspace 访问权限- 如果你还不知道 workspace ID 或 slug,可以先执行
lody workspace list sessionId可以显式传入,也可以通过环境变量LODY_SESSION_ID提供
| 子命令 | 作用 | 是否需要本地运行进程 | 帮助命令 |
|---|---|---|---|
lody session create | 在当前机器创建新 session | 是 | lody session create --help |
lody session chat | 给现有本地 session 发送新一轮用户输入 | 是 | lody session chat --help |
lody session cancel | 取消当前机器上某个 session 正在运行的 turn | 是 | lody session cancel --help |
lody session list | 列出某个 workspace 下的 session | 否 | lody session list --help |
lody session history | 读取用户可见的对话 transcript | 否 | lody session history --help |
lody session show | 查看 session 元数据 | 否 | lody session show --help |
lody session rename | 重命名 session | 否 | lody session rename --help |
lody session archive | 归档 session | 否 | lody session archive --help |
lody session restore | 恢复已归档 session | 否 | lody session restore --help |
lody session delete | 永久删除已归档 session | 否 | lody session delete --help |
session create
在当前机器上创建一个新 session,并绑定到 GitHub 仓库或已注册的本地项目。
lody session create --workspace my-team --agent-config codex --repo owner/repo "修复失败测试"常用参数:
--workspace <idOrSlug>:指定目标 workspace--agent-config <idOrName>:选择代理配置--repo <owner/repo>:绑定 GitHub 仓库--local-project <id|name|path>:绑定一个已注册的本地项目--repo与--local-project二选一--branch <name>:指定起始分支--mode <modeId>、--model <modelId>:覆盖 ACP 的 mode / model--env KEY=VALUE:可重复传入,会随 session 一起保存,供后续恢复时继续使用- prompt 可以来自位置参数、
--prompt、--prompt-file或 stdin
精确参数:
lody session create --helpsession chat
给一个已有 session 发送新的一轮用户输入。
lody session chat <sessionId> "继续处理上一个 patch"
LODY_SESSION_ID=<sessionId> lody session chat --prompt "继续处理上一个 patch"常用参数:
sessionId可以来自位置参数,也可以来自LODY_SESSION_ID- prompt 可以来自位置参数、
--prompt、--prompt-file或 stdin --mode <modeId>、--model <modelId>:覆盖本轮使用的 ACP mode / model
精确参数:
lody session chat --helpsession cancel
取消某个本地 session 当前正在运行的 turn。
lody session cancel <sessionId>如果取消失败,命令会返回非零退出码。精确参数:
lody session cancel --helpsession list
列出某个 workspace 下的 session。默认只显示活跃 session。
lody session list --workspace my-team
lody session list --workspace my-team --archived
lody session list --workspace my-team --all --limit 50 --json常用参数:
--archived:只看已归档 session--all:同时显示活跃和已归档 session--limit <count>:限制结果条数- 默认输出为表格,
--json输出结构化结果
精确参数:
lody session list --helpsession history
读取一个 session 的“用户可见 transcript”。这个命令会过滤掉思考过程、工具调用等非用户可见内容。
lody session history <sessionId> --limit 20
lody session history <sessionId> --all --reverse
lody session history <sessionId> --jsonl常用参数:
--limit <count>:读取最近 N 条可见 turn--all:读取完整可见 transcript--reverse:按最新在前输出--json、--jsonl:适合自动化或管道处理
精确参数:
lody session history --helpsession show
查看 session 的元数据摘要,例如状态、机器、workspace 绑定和 history 数量。
lody session show <sessionId>
lody session show <sessionId> --json精确参数:
lody session show --helpsession rename
重命名一个 session。
lody session rename <sessionId> "新的标题"
LODY_SESSION_ID=<sessionId> lody session rename --title "新的标题"如果你依赖 LODY_SESSION_ID 选中 session,建议使用 --title,避免把标题误解释成显式 session 选择器。
精确参数:
lody session rename --helpsession archive
归档一个 session。归档后它会从活跃列表中移走,但仍然可以恢复。
lody session archive <sessionId>精确参数:
lody session archive --helpsession restore
把一个已归档 session 恢复到活跃列表。
lody session restore <sessionId>这个命令只适用于已经归档的 session。精确参数:
lody session restore --helpsession delete
永久删除一个已归档 session。删除后会同时排队执行机器侧清理,以释放 worktree 和运行时资源。
lody session delete <sessionId>这个命令只适用于已经归档的 session。精确参数:
lody session delete --helpMachine 命令
Machine 命令用于查看某个 workspace 中注册了哪些机器,以及它们当前是否在线。
| 命令 | 作用 | 帮助命令 |
|---|---|---|
lody machine list | 列出 workspace 下的机器 | lody machine list --help |
machine list
lody machine list --workspace my-team
lody machine list --workspace my-team --online-only
lody machine list --workspace my-team --json
lody machine list --workspace my-team --json --include-acp-capabilities默认表格只显示机器 ID、名称、在线状态,以及合并后的 CLI 列 (内置 CLI 和 registry agent 会一起显示在 CLI 列中)。
- 默认同时显示在线和离线机器
- 如需只看最近有心跳的机器,使用
--online-only --json默认不输出acpCapabilities,以减少返回体体积- 只有显式传入
--include-acp-capabilities时,JSON 输出才会包含能力缓存
这在执行 agent-config refresh-capabilities 前很有帮助。
精确参数:
lody machine list --helpAgent Config 命令
Agent config 命令对应 Web 端的代理配置。
使用前建议先了解:
- 选择器支持 ID 或名称
- 如果多个 config 或 machine 重名,CLI 会直接要求你改用显式 ID
refresh-capabilities目前在 CLI 中只支持当前机器
| 子命令 | 作用 | 帮助命令 |
|---|---|---|
lody agent-config list | 列出 workspace 中的 agent config | lody agent-config list --help |
lody agent-config show | 查看单个 agent config | lody agent-config show --help |
lody agent-config create | 创建新的 agent config | lody agent-config create --help |
lody agent-config update | 更新已有 agent config | lody agent-config update --help |
lody agent-config delete | 删除 agent config | lody agent-config delete --help |
lody agent-config refresh-capabilities | 刷新支持的 modes、models 与 config options | lody agent-config refresh-capabilities --help |
agent-config list
lody agent-config list --workspace my-team默认显示配置 ID、名称、agent type 和描述。
agent-config show
lody agent-config show <idOrName>
LODY_AGENT_CONFIG_ID=<id> lody agent-config show可以以易读文本或 JSON 的方式查看完整配置。
agent-config create
创建一个内置或 registry 类型的 agent config。
lody agent-config create \
--workspace my-team \
--agent-type codex \
--name "Codex Default" \
--env OPENAI_API_KEY=... \
--prompt "结束前请先跑测试"常用参数:
--agent-type <type>:必填claude与codex会被视为内置 runtime- 其他
agent-type会被视为 registry runtime --env KEY=VALUE:可重复传入--env-file <path>:从文件读取环境变量--prompt或--prompt-file:设置默认 prompt 前缀
精确参数:
lody agent-config create --helpagent-config update
就地更新已有配置。
lody agent-config update <idOrName> --name "Codex CI"
lody agent-config update <idOrName> --env OPENAI_API_KEY=... --unset-env OLD_KEY
lody agent-config update <idOrName> --prompt ""常用参数:
--name:更新显示名称--description "":清空描述--env、--env-file:合并新的环境变量--unset-env KEY:删除一个或多个环境变量--prompt "":清空默认 prompt 前缀
精确参数:
lody agent-config update --helpagent-config delete
lody agent-config delete <idOrName>按 ID 或唯一名称删除一个 agent config。
agent-config refresh-capabilities
刷新某个 agent config 在当前机器上的能力缓存。
lody agent-config refresh-capabilities <idOrName> --workspace my-team适合在这些场景下执行:
- 安装或升级了 coding CLI
- 修改了 agent config 的环境变量
- 本机可用的 models 或 modes 发生了变化
常用参数:
--machine <idOrName>:默认当前机器- 目标机器必须在线
- CLI 目前不支持跨机器刷新,只能对当前机器执行
--json、--jsonl:适合自动化调用
精确参数:
lody agent-config refresh-capabilities --help常见示例
# 先找到要使用的 workspace id 或 slug
lody workspace list
# 查看这个 workspace 里已经链接的 GitHub 仓库
lody github list --workspace my-team
# 查看这个 workspace 里的 agent config
lody agent-config list --workspace my-team
# 在后台启动当前机器上的本地 daemon
lody daemon start
# 临时前台调试也可以使用
lody start
# 在 GitHub 仓库中创建一个 session
lody session create \
--workspace my-team \
--agent-config codex \
--repo owner/repo \
"修复失败测试"
# 读取最近 20 条用户可见 transcript
lody session history <sessionId> --limit 20
# 查看在线机器,并刷新当前机器上的能力缓存
lody machine list --workspace my-team --online-only
lody agent-config refresh-capabilities codex --workspace my-team