跳转到内容

CLI 命令参考

Switch to Zen Mode

启动 Mutsumi TUI 任务看板。

Terminal window
mutsumi [选项] [子命令]
选项短写说明默认
--path PATH-p任务文件路径./mutsumi.json(回退:./tasks.json
--watch PATH-w额外监听的任务文件路径(可重复)
--version显示版本号并退出
--help显示帮助并退出
Terminal window
# 启动 TUI(监听当前目录的 mutsumi.json)
mutsumi
# 指定文件路径
mutsumi --path /path/to/mutsumi.json
# 同时监听多个文件(多项目)
mutsumi --path ~/proj-a/mutsumi.json -w ~/proj-b/mutsumi.json
# 打印版本号
mutsumi --version

首次启动时,引导向导会自动运行。详见启动流程


创建新任务并追加到 mutsumi.json

Terminal window
mutsumi add 标题 [选项]
选项短写类型可选值默认
--priority-P选择high, normal, lownormal
--scope-s选择day, week, month, inbox配置中的 default_scope
--tags-t字符串逗号分隔[]
--description-d字符串自由文本
Terminal window
# 最简
mutsumi add "修复登录 Bug"
# 完整选项
mutsumi add "修复登录 Bug" -P high -s day -t "bugfix,urgent" -d "刷新时会话过期"
# 短标志
mutsumi add "写测试" -P low -s week -t "dev"

自动生成唯一 ID 和 created_at 时间戳。


列出 mutsumi.json 中的任务。

Terminal window
mutsumi list [选项]
选项短写类型可选值默认
--scope-s选择day, week, month, inbox全部
--done / --no-done标志显示全部
Terminal window
# 列出所有任务
mutsumi list
# 按 scope 过滤
mutsumi list --scope day
# 仅显示待办
mutsumi list --no-done
# 仅显示已完成
mutsumi list --done

标记任务完成(支持 ID 前缀匹配)。

Terminal window
mutsumi done TASK_ID
参数说明
TASK_ID完整任务 ID 或唯一前缀
Terminal window
# 完整 ID
mutsumi done 01JQ8X7K3M0000000000000001
# 前缀匹配
mutsumi done 01JQ
# 前缀不唯一时,列出匹配项
mutsumi done 01
# 错误:多个任务匹配 '01',请输入更长的前缀。

设置 status"done" 并自动填充 completed_at


编辑任务字段(支持 ID 前缀匹配)。

Terminal window
mutsumi edit TASK_ID [选项]
选项短写类型可选值说明
--title字符串新标题
--priority-P选择high, normal, low新优先级
--scope-s选择day, week, month, inbox新 scope
--tags-t字符串逗号分隔替换标签
--description-d字符串自由文本新描述
Terminal window
# 改标题
mutsumi edit 01JQ --title "新标题"
# 改优先级和 scope
mutsumi edit 01JQ -P low -s week
# 替换标签
mutsumi edit 01JQ -t "docs,review"
# 更新描述
mutsumi edit 01JQ -d "需求变更"

删除任务(支持 ID 前缀匹配)。

Terminal window
mutsumi rm TASK_ID
参数说明
TASK_ID完整任务 ID 或唯一前缀
Terminal window
mutsumi rm 01JQ

删除任务及其所有子任务。


生成模板 mutsumi.json

Terminal window
mutsumi init [选项]
选项说明
--force覆盖已有文件
--personal初始化个人任务文件 ~/.mutsumi/mutsumi.json
--project在当前目录创建 mutsumi.json 并注册为项目源
Terminal window
# 在当前目录创建 mutsumi.json
mutsumi init
# 覆盖已有文件
mutsumi init --force
# 初始化个人任务
mutsumi init --personal
# 创建并注册为项目
mutsumi init --project

配置 AI Agent 集成。将 Agent Skills 通过符号链接安装到 Agent 的技能目录。

Terminal window
mutsumi setup [选项]
选项短写类型可选值默认
--agent-a选择claude-code, codex-cli, opencode, gemini-cli, aider, custom
--mode选择skills, skills+project-doc, snippetskills
模式行为
skills将 5 个 Mutsumi 技能文件(mutsumi-managemutsumi-trackmutsumi-planmutsumi-reportmutsumi-context)以符号链接形式从 ~/.mutsumi/skills/ 安装到 Agent 的技能目录。
skills+project-doc安装技能,并将 ## Mutsumi Task Integration 部分追加到 Agent 的项目文档(CLAUDE.mdAGENTS.md 等)。
snippet将集成 prompt 打印到标准输出,供手动粘贴。不安装任何文件。
技能用途自动触发?
mutsumi-manage任务增删改查(添加、编辑、完成、删除)否 — 用户请求时
mutsumi-track工作时自动更新任务进度
mutsumi-plan将目标分解为子任务否 — 用户请求时
mutsumi-report生成状态摘要否 — 用户请求时
mutsumi-context会话开始时加载任务板上下文
Agent目录
Claude Code~/.claude/skills/
Codex CLI~/.agents/skills/
Gemini CLI~/.gemini/skills/
OpenCode~/.config/opencode/skills/
Terminal window
# 列出可用 Agent 和模式
mutsumi setup
# 为 Claude Code 安装技能(默认模式)
mutsumi setup --agent claude-code
# 安装技能 + 注入项目文档到 CLAUDE.md
mutsumi setup --agent claude-code --mode skills+project-doc
# 打印 prompt 供手动使用(Aider、自定义 Agent)
mutsumi setup --agent custom --mode snippet
# 为其他 Agent 安装技能
mutsumi setup --agent gemini-cli
mutsumi setup --agent codex-cli
mutsumi setup --agent opencode

重复运行是安全的 —— 会替换过期的符号链接,不会重复安装。


从旧版文件名和配置位置迁移。

Terminal window
mutsumi migrate [选项]
选项说明
(无)在当前目录将 tasks.json 重命名为 mutsumi.json
--config迁移配置目录(~/.config/mutsumi/~/.mutsumi/
--all同时迁移任务文件和配置目录
Terminal window
# 迁移 tasks.json → mutsumi.json
mutsumi migrate
# 迁移配置目录
mutsumi migrate --config
# 全部迁移
mutsumi migrate --all

管理注册的项目源。

Terminal window
mutsumi project add PATH

注册一个项目目录为数据源。该目录应包含(或将包含)mutsumi.json

Terminal window
mutsumi project add .
mutsumi project add ~/projects/saas-app
Terminal window
mutsumi project remove NAME

取消注册一个项目。

Terminal window
mutsumi project remove saas-app
Terminal window
mutsumi project list

列出所有注册的项目及其路径。


校验任务文件的 schema。

Terminal window
mutsumi validate

校验 mutsumi.json(或 --path 指定的文件)。报告缺失必填字段、无效枚举值和格式错误。

Terminal window
# 校验默认文件
mutsumi validate
# 校验指定文件
mutsumi -p /path/to/mutsumi.json validate

输出 mutsumi.json 的 JSON Schema。

Terminal window
mutsumi schema
Terminal window
# 打印到终端
mutsumi schema
# 输出到文件
mutsumi schema > schema.json

接受 TASK_ID 参数的命令(doneeditrm)支持前缀匹配。无需输入完整 ID:

Terminal window
mutsumi done 01EX # 如果只有一个 ID 以 "01EX" 开头则匹配

前缀不唯一时,Mutsumi 会列出所有匹配项并要求你输入更长的前缀。


代码含义
0成功
1一般错误(文件未找到、ID 不唯一等)
2参数无效