CLI 命令全表
Vyane 命令行的完整参考——按类别分组的所有子命令、作用和关键参数,以源码真实注册为准。
Vyane 的命令行入口是 vyane(源码里对应 src/vyane/cli.py)。它和 MCP 工具、HTTP 接口共用同一套后端逻辑,所以命令行能做的事,基本就是 Vyane 全部能力的直接映射:派发单个任务、多模型并发、代码审查、看板读写、目标连续性、会话管理、可编程编排等等。
这一页把所有子命令按类别列全,每张表给出 命令 | 作用 | 关键参数。所有条目都来自源码实地核查,不是手写清单。
怎么看这一页
命令都写成 vyane <命令> [子命令] 形式。带子命令的(像 board、goal、session)会先给一句总览,再单独展开子命令表。「关键参数」只列常用的、影响行为的那几个,不是穷举全部 flag——完整参数随时用 vyane <命令> --help 查。
核心执行:派发与并发
这四个是 Vyane 最常用的入口——把一个任务交给模型跑。
| 命令 | 作用 | 关键参数 |
|---|---|---|
vyane dispatch <task> | 把单个任务派给一个 provider 执行,输出统一 JSON 结果 | --provider/-p(默认 auto 智能路由,支持 provider/model 写法)、--model/-m、--profile、--sandbox(read-only/write/full,默认只读)、--timeout/-t、--workdir/-w、--session(接续持久会话)、--agent-id、--failover(主 provider 不可用时才试别家)、--eos-card(把这次工时记到某张看板卡) |
vyane broadcast <task> | 把同一任务并发发给多个 provider,拿来做共识或对比 | --providers(provider 列表,支持 provider/model?profile=... 写法)、--providers-json(每个 provider 单独配 profile/model/timeout 的 JSON 数组)、--compare(附结构化对比:相似度、速度排名)、--model/-m、--profile、--sandbox、--timeout/-t |
vyane review | 在当前分支或某个 PR 上跑多专家代码审查(专家并行扫 → 聚合 → 校验) | --pr(PR 号,与 --base 互斥)、--base/--head、--specialists(逗号分隔的专家名,默认全部)、--specialist-model(NAME=MODEL,... 逐专家换模型)、--verifiers(校验队规模,默认 4)、--no-verify、--no-merger、--concurrency、--timeout-per-specialist、--json |
vyane workflow run <script.js> | 在 Deno 沙箱里执行一段可编程编排脚本(脚本内 agent() 落到 dispatch) | --args(传给脚本的 JSON)、--sandbox-default、--workdir/-w、--budget-tokens/--budget-usd(预算硬闸)、--timeout(wall-clock 硬杀,默认 3600 秒)、--resume-from(按 run_id 前缀回放,不重烧配额)、--fake-dispatch(演示用假派发) |
几个最容易记错的参数
- 接续上下文用
vyane dispatch --session <id>,不是--vyane-session。 - broadcast 开对比用
--compare开关,不是--mode compare。共识、辩论这类协作模式在 MCP 的vyane_collaborate里(见下方「MCP 专属」)。 - review 指定模型用
--specialists挑专家、--specialist-model换模型,不是--providers。 --async-mode是 MCP 工具参数,命令行没有这个 flag。
看板:Beacon 账本读写
vyane board <子命令> 通过 Vyane 读写 Beacon 看板账本。写操作默认会 commit 并 push,带 --no-push 只本地提交。所有子命令都要 --board-dir 指向看板目录。
| 命令 | 作用 | 关键参数 |
|---|---|---|
vyane board status | 列出看板任务(可按状态、项目、优先级、负责人、标签筛选) | --board-dir、--state、--project、--priority、--assignee、--label、--mine(看 --by 名下在做/在审的卡)、--sort、--limit、--json |
vyane board show <id> | 展开单张卡的日志和决策 | --board-dir、--json |
vyane board take <id> | 领一张卡,并 commit 账本更新 | --board-dir、--by(默认 sui)、--role(默认 Developer)、--runtime、--model、--next、--worktree、--branch、--no-push、--json |
vyane board log <id> | 追加一条卡日志并 commit | --m(日志文本,必填)、--board-dir、--no-push、--json |
vyane board done <id> | 标记完成并 commit | --m(收尾说明,可选)、--board-dir、--no-push、--json |
vyane board drop <id> | 把在做的卡放回待办并 commit | --board-dir、--no-push、--json |
vyane board cancel <id> | 取消一张卡并 commit | --m(取消原因,必填)、--by、--board-dir、--no-push、--json |
vyane board new <title> | 在 triage 建一张新卡并 commit | --board-dir、--project(必填)、--priority、--desc、--label、--by、--runtime、--next、--no-push、--json |
vyane board render | 生成看板渲染产物(BOARD.md/board.json 等) | 默认只算 render plan 不写文件;--write(写出但不 commit)、--check(有差异退出码 1,给 CI)、--board-dir、--json |
board 几个易错点
建卡是 vyane board new "标题" --project ...,标题是位置参数、不是 --title。log / cancel 的文本用 --m(都必填)。写操作默认推 Git,不想 push 加 --no-push。render 不带 --write 就是预览(没有 --dry-run 这个 flag)。
目标连续性:goal
vyane goal <子命令> 管理持久化目标。真值是 JSONL,SQLite 只是派生索引。这套系统专门解决「主模型被配额挡住后,怎么接力继续跑」——所以除了增删改查,还有一整套 continuity-* 命令。
基础生命周期:
| 命令 | 作用 | 关键参数 |
|---|---|---|
vyane goal create | 建一个目标(默认排队态) | --title(必填)、--description、--priority(0 紧急..4 待办)、--parent、--acceptance(可重复,如 pr-merged:owner/repo#42) |
vyane goal list | 列目标(走 SQLite 索引) | — |
vyane goal get <id> | 看单个目标详情 | — |
vyane goal next | 显示优先级最高的排队目标 | — |
vyane goal start <id> | 把排队/暂停的目标推进到进行中 | --device、--pursue(启动本地追踪循环)、--runtime、--workdir |
vyane goal progress <id> | 追加一条进展事件 | — |
vyane goal pause / resume <id> | 暂停 / 恢复目标 | — |
vyane goal done / fail / cancel <id> | 标记完成 / 失败 / 取消(后两者是终态) | — |
vyane goal verify <id> | 跑本地验收检查并记录结果 | — |
vyane goal cc-mirror | 建一个绑定当前 Claude Code 会话的目标 | — |
vyane goal reindex | 从 JSONL 真值重建 SQLite 索引 | — |
vyane goal vacuum | 归档 N 天前的完成/失败/取消目标 | — |
连续性(接力)相关:
| 命令 | 作用 |
|---|---|
vyane goal continuity-scan | 把配额账本事件应用到目标连续性状态机 |
vyane goal continuity-preview | 预览已就绪的接力交接命令,不真派发 |
vyane goal continuity-next-action | 显示下一个操作员可见的接力动作,不写状态 |
vyane goal continuity-approvals | 为就绪的接力命令排审批记录 |
vyane goal continuity-execute | 构建或记录一次已批准的接力交接执行 |
vyane goal continuity-runner | 跑 launchd-safe 的连续性扫描并排审批(给定时任务用) |
vyane goal continuity-signal <id> | 记录一个外部「接力就绪」信号 |
会话与记录:session / session-records
逻辑会话是话题级的任务容器,不绑模型或引擎,支持 resume/handoff。
| 命令 | 作用 | 关键参数 |
|---|---|---|
vyane session create <title> | 建一个新会话 | --description |
vyane session list | 列出已持久化的会话 | --status(active/archived/all) |
vyane session history | 看某会话的派发历史 | — |
vyane session message | 给会话追加一条中性消息 | — |
vyane session bind | 把「agent/provider 对」绑到某个 runtime 会话 id | — |
vyane session archive | 归档一个会话 | — |
vyane session-records <子命令> 负责把 Codex / Claude 的原生 JSONL 对话记录导入并检索:
| 命令 | 作用 |
|---|---|
vyane session-records scan | 找默认的 Codex/Claude JSONL 源文件 |
vyane session-records import | 导入 JSONL 记录 |
vyane session-records manifest | 查看或初始化跨设备源清单 |
vyane session-records list | 列已导入记录 |
vyane session-records imports | 列最近的导入/检查运行 |
vyane session-records stats | 导入统计 |
vyane session-records show | 看单条导入记录 |
历史与观测:history / dashboard / monitor / status
| 命令 | 作用 | 关键参数 |
|---|---|---|
vyane history | 看派发历史和统计 | --stats(聚合统计)、-n/--limit、--provider、--hours、--costs(含成本估算)、--source、--json |
vyane history benchmark | 跑 provider 基准测试套件 | — |
vyane history export | 导出历史到 CSV/JSON/Markdown | — |
vyane worktime-forecast | 生成 Beacon 看板的工时/ETA 桥接文件 | — |
vyane dashboard | 启动 Web 监控面板 | --host(默认 127.0.0.1)、--port(默认 41521) |
vyane monitor | 实时 TUI 任务监视器(需装 vyane[tui]) | --owner-user-id |
vyane status | 监视活跃派发 | — |
配置与环境:init / config / check / profile / capabilities
| 命令 | 作用 | 关键参数 |
|---|---|---|
vyane init | 交互式配置向导 | — |
vyane config | TUI 配置面板 | — |
vyane check | 检查本机哪些模型 CLI 可用 | --json |
vyane mcp-smoke | 用真实 MCP 客户端验证本地 MCP stdio 能起来 | — |
vyane profile [name] | 列出或展开配置 profile(provider/harness/model/protocol 的命名组合) | --json |
vyane capabilities | 显示 provider/model 的引擎能力清单 | --workdir/-w、--collaboration(显示团队/集群/组织协作模板)、--json |
vyane feedback | 提交或查看用于路由的用户反馈 | --run-id、--provider、--rating(1-5)、--comment、--category、--list、--hours |
vyane clean [what] | 清理数据文件(历史/审计/反馈等) | what(all/history/audit/feedback/status/benchmark)、--dry-run、--yes |
想法与记忆:idea / memory
| 命令 | 作用 | 关键参数 |
|---|---|---|
vyane idea add | 捕获一条个人想法 | — |
vyane idea list | 列出已捕获的想法 | — |
vyane idea promote | 把想法升格为任务卡、记忆或笔记 | — |
vyane idea route | 给想法分类,并可选地路由出去 | — |
vyane memory add | 加一条 daemon 记忆记录 | — |
vyane memory search | 搜索 daemon 记忆记录 | — |
vyane memory benchmark | 对所有已配置 embedding 做离线 A/B 对比 | — |
vyane memory export / import | 导出 / 导入记忆记录(JSON) | — |
vyane memory dream | 生成一条归纳式的记忆合成记录 | — |
vyane memory index-session | 把会话摘要索引进记忆 | — |
后台运维:daemon / research / maintenance / worker / message
这批命令面向长驻 daemon 和自动化。
| 命令 | 作用 | 关键参数 |
|---|---|---|
vyane daemon-status | 看 daemon 快照(活跃 worker / 事件数 / 24 小时成本) | — |
vyane daemon-restart | 重启 launchd 托管的 daemon | — |
vyane research start | 通过 daemon 启动一个后台 Opus 研究战役 | — |
vyane research status / stop | 看 / 停研究战役 | — |
vyane maintenance list / show | 列出 / 查看内置维护任务 | — |
vyane maintenance prompt | 渲染一个维护任务的 prompt | — |
vyane maintenance command | 打印可给 cron/launchd 用的 shell 命令 | — |
vyane maintenance run | 通过 provider 派发一个维护任务 | — |
vyane maintenance schedule <...> | 管理 daemon 维护排程(list/show/add/update/delete/due/runs/run-due) | — |
vyane maintenance writeback <...> | 规划归档格式的 writeback 产物(仅 dry-run) | — |
vyane worker topology | 看父子 worker 拓扑 | — |
vyane worker cancel-tree | 取消一个 worker 及其所有后代 | — |
vyane worker spawn-child | 派生一个子 worker 并把结果回传给父 | — |
vyane message send / list / claim / reply / ack | 通过 daemon 收件箱收发、认领、确认 worker 消息 | — |
A2A 与通知:a2a / a2a-server / notify
| 命令 | 作用 | 关键参数 |
|---|---|---|
vyane a2a-server | 启动 A2A HTTP 服务(Agent-to-Agent 协作协议) | --host、--port(默认 41520,和 dashboard 不是一个端口)、--workdir |
vyane a2a send / inbox / read | 收发本地 AgentRun A2A 队列消息 | — |
vyane notify | 给外部通知渠道和 NotificationStore 发一条异常通知 | --summary(必填)、--reason(goal-stale/gh-check-stuck/review-flaky/daemon-down/... 必填)、--severity、--pr/--url(可重复)、--dry-run、--json |
其它工具
| 命令 | 作用 | 关键参数 |
|---|---|---|
vyane pulse generate | 生成本地 Pulse 卡片到 Pulse store | — |
vyane pulse export | 把已存 Pulse 卡片导出成 MDX 草稿 | — |
vyane mirror set / create / status / list | 管理逻辑会话到外部渠道的镜像映射 | — |
vyane review-gc | 清理旧的 .vyane/reviews 产物 | — |
vyane team-plan | 从 issue 摘要 dry-run 一个多团队分阶段计划 | — |
vyane gh-watchdog | 扫开着的 PR 找卡住/失败的检查并通知 | — |
vyane session-watchdog | 检测过期的 Claude Code / Codex / daemon 会话并通知 | — |
vyane benchmark | 跑 provider 基准测试套件 | — |
vyane version | 显示版本 | — |
collaborate 和 orchestrate 在哪
「多轮协作 + 收敛」(collaborate,含 Debate/Vote/Hierarchy/Chain 模式)和「任务编排原语」(orchestrate,phase 分解、team 分配)目前是 MCP 工具入口(vyane_collaborate / vyane_orchestrate),命令行没有对应子命令。要在命令行做可编程编排,走 vyane workflow run。