input-kanban
v0.0.22
Published
A local Codex orchestration kanban dashboard
Maintainers
Readme
Input Kanban
中文 | English
你可以把 Input Kanban 当成一个本地 Codex 执行看板:先把任务放进来,再让它自动拆分、派发、执行和验收。下面重点讲怎么用,不是讲内部实现。
最快开始
1. 安装
npm install -g input-kanban确认可用:
input-kanban --help2. 进入目标工作区
在你要让 Codex 修改或检查的目录里启动:
cd /path/to/your/workspace
input-kanban默认会启动本地服务:
http://127.0.0.1:8787打开浏览器后,你就可以直接创建任务批次、看执行状态、看结果。
3. 不想先 cd?直接指定工作区
input-kanban --workspace /path/to/your/workspace--repo 也可以继续用,作为兼容别名。
最常见的 6 个用法
1) 在网页里新建并自动执行
- 点击
新建任务批次 - 填好工作区、Worker 沙箱和任务说明
跳过 Codex Git/信任目录检查默认勾选;如果不是可信 umbrella / 非 Git 根目录,可取消勾选- 点击
创建批次 - 看板会自动发起
拆分任务 - 拆分完成后自动派发 worker
- 所有批次完成后自动发起最终验收
2) 从终端直接提交一个任务
input-kanban submit --task "修复登录问题,并补充回归测试" --label "修复登录问题"如果你想从文件读任务:
input-kanban submit --task-file task.md如果目标是可信的 umbrella / 非 Git 工作区,可显式传给 Codex:
input-kanban submit --task-file task.md --codex-skip-git-repo-check3) 先看计划,再决定是否执行
input-kanban submit --task-file task.md --plan-approval这会在规划完成后停在“已拆分,待确认”,等你在 Web 上点 开始执行 再继续。
4) 只想创建并规划,不马上派发
input-kanban submit --task-file task.md --no-auto5) 查看进度 / 结果 / 重试 / 停止
input-kanban status <runId>
input-kanban status <runId> --watch
input-kanban result <runId>
input-kanban result <runId> --copy
input-kanban retry <runId> [taskId]
input-kanban stop <runId>Agent 与 handoff 工作流
CLI-only Agents
如果你是只会调用 CLI 的 Agent,直接运行:
input-kanban guide或者:
input-kanban --helpguide 会输出一个更适合 Agent 的操作循环和可直接复制的示例模板。
安装 input-kanban-prepare skill
如果你想把内置的 input-kanban-prepare skill 安装到 Codex:
input-kanban install-skill codex这个 skill 专门用于把外部 Agent 对话整理成可执行的 task.md 交给看板:它会帮你补齐 Goal、Acceptance Criteria、Expected Artifacts、Context References、Risks,并在需要时建议批次和并行度。它不负责执行任务,也不负责最终验收。
如需指定 Codex skills 根目录:
input-kanban install-skill codex --target-dir ~/.codex/skills外部 Agent 对话交给看板执行
如果任务先在 Claude、Cursor、Codex 或其它外部 Agent 对话里讨论,建议先整理成结构化 task.md,再交给 Input Kanban:
input-kanban submit --task-file task.md --plan-approval推荐 task.md 至少包含:
Goal:这次要完成什么Acceptance Criteria:怎么判断完成Expected Artifacts:期望产物和验证方式Context References:相关文件、spec、历史记录Risks:风险、假设和不确定点
可以参考 skills/input-kanban-prepare/SKILL.md 或 docs/input-kanban-prepare.md。这样 planner 会拿到更稳定的执行契约,而不是从一段模糊需求里从零猜。
常用命令速查
input-kanban submit --task "..."
input-kanban submit --task-file task.md
input-kanban submit --task-file task.md --plan-approval
input-kanban submit --task-file task.md -d
input-kanban install-skill codex
input-kanban deps tmux
input-kanban --json runs --active
input-kanban --json status <runId>
input-kanban --json result <runId>
input-kanban --json retry <runId> [taskId]
input-kanban --json stop <runId>如果你需要让脚本或其它工具接管,--json 会给出结构化输出。
tmux 模式(可选)
默认 runner 是 headless。如果你想在终端里实时看每个角色怎么跑,可以切到 tmux:
input-kanban submit --task-file task.md --runner tmuxtmux 模式适合:
- 想看 planner / worker / judge 的实时终端输出
- 想在 batch window 里同时看 overview pane 和 worker panes
- 想在本地排查执行过程
如果你不需要终端可视化,就继续用默认的 headless。
Web 新建任务批次时也可以选择 runner:
跟随默认:使用本机配置里的默认 runnerheadless:当前批次强制使用 headlesstmux:当前批次强制使用 tmux
默认 runner 会保存到本机配置文件 ~/.input-kanban/config.json,CLI 和 Web 共用;如果设置了环境变量 KANBAN_RUNNER,环境变量优先。
如果 Web 里选择 tmux 但本机没有检测到 tmux,会禁止创建批次并提示安装命令。Web 不会直接安装系统依赖;需要在终端里显式执行:
input-kanban deps install tmux安装命令会按平台选择常见包管理器,例如 Windows 的 winget/psmux、macOS 的 Homebrew、Linux 的 apt/dnf/pacman/zypper/apk。Windows 上的 psmux 是第三方 tmux 兼容实现;也可以自行安装其他实现,只要当前环境里有可用的 tmux 命令即可。执行安装前会展示将运行的命令并要求确认;也可以先查看计划:
input-kanban deps install tmux --dry-run数据会存到哪里
默认运行数据目录是:
~/.input-kanban/runs每个 run 大致会长这样:
runs/<runId>/
├── task.md
├── plan.json
├── run_state.json
├── planner/
├── workers/<taskId>/
└── judge/
├── judge_input.json
└── verdict.json这些都是本地运行记录,不需要提交到你的业务仓库。
你通常会怎么用它
- 把一个较大的 Codex 编程任务拆成多个执行步骤
- 在 Web 里看计划、执行、结果
- 在终端里自动提交、查看、重试、停止
- 在需要时用
plan-approval增加一个人工确认关口 - 在需要终端细节时用
tmux看实时过程
使用前提
- Node.js 20 或更高版本
- 已安装并可用的 Codex CLI
- 如果要用
--runner tmux,本机需要安装tmux - 可用
input-kanban deps tmux检查 tmux 状态 codex命令在终端可用,或通过--codex-bin指定可执行文件
维护者开发
如果你要开发 Input Kanban 本身:
git clone https://github.com/zhang3xing1/Input-Kanban.git
cd Input-Kanban
npm install
npm start本地 CLI 开发:
npm link
input-kanban --help检查:
npm run check