新手指南
目标读者:第一次接触本工具的用户(人或 AI)。读完能跑通「安装 → 初始化 → 建档 → 归档」最短路径,并知道去哪查更细的内容。
解决什么问题
你刚接手(或刚让 AI 接手)一个项目,方案确认完、代码改完,但:
- 决策过程只存在于 AI 对话里,会话关掉就没了
- 任务记录零散,谁在做、做到哪、为什么这么做,无从查起
- 发版 CHANGELOG 要人肉维护多语言
本工具用一套纯 Markdown 任务文件 + 一条 CLI 解决前三点,第四点见完整攻略 · 多语言 CHANGELOG。
谁适合用
核心是开发人员(全功能:任务协作 + 发版 CHANGELOG),但不限于开发——只要工作产物在 git 仓库里、有 AI 助手代操作,就能用:
| 角色 | 典型用法 |
|---|---|
| 产品经理 | 把需求清单整理成 Excel/CSV(列名写「任务名/负责人/状态/截止日期」等常见叫法即可),让 AI 执行导入转成规范任务文件,开发接手就是标准格式;需求里的手机号/邮箱落盘自动脱敏 |
| 项目经理 | 按负责人/范围/状态过滤任务总览(--owner/--scope/--status),导出 XLSX 做汇报;任务依赖闭环校验提前暴露排期断链 |
| 测试 / QA | 缺陷修复与回归任务跟踪(状态含「阻塞」,适配缺陷流转),归档后作为测试记录可追溯 |
| 运维 / SRE | 变更与发布任务台账;内网 URL、IP、密钥落盘自动掩码;发版记录走多语言 CHANGELOG |
| 技术负责人 | 全景总览查成员负载,check 校验保证多人 + 多个 AI 产出格式一致 |
| 独立开发者 / 自由职业者 | 跨会话工作记忆:AI 会话关掉,结论还在仓库里 |
⚠️ 两条诚实边界:这是轻量文件型任务管理,没有甘特图、看板、消息通知、打卡型工时统计(任务完成周期与吞吐可用 toolkit tasks stats 统计),Jira 级的复杂项目管理不适用;任务区生长在 git 仓库里,工作产物不进 git 的协作场景(客服工单、招聘流程等)用不上。
几个术语,先说人话
如果你还没深入研究过 AI 编程生态,先看这张表再看正文(都懂可直接跳过):
| 术语 | 说人话 |
|---|---|
| AI 编程助手 | 装在编辑器里能帮你写代码的工具,如 Trae、Claude Code、Cursor |
| agent | 能自己读文件、跑命令、多步干活的 AI 助手(不是一问一答的聊天机器人) |
| skills(技能) | 给 agent 看的「岗位说明书」:一份 Markdown 文件,写清楚某类工作该怎么做。agent 遇到对应任务时自动照着执行 |
| MCP | agent 连接外部工具的通用插口(本工具不依赖它,知道有这回事即可) |
| CLI | 命令行工具,就是本文的 toolkit 命令 |
| 归档 | 把已完成的任务文件从「进行中」目录挪进「已归档」目录,像账本结账 |
一句话关系:skills 教 AI 怎么做,CLI 帮人(和 AI)做得快。
安装
三种方式按场景选一:团队项目推荐方式一(版本随仓库锁定,成员与 CI 自动一致);个人多项目推荐「双全局」——工具用方式二全局装 + skills 全局装(见下文 skills 安装),所有项目开箱即用,升级各一条命令:
方式一:项目 devDependency(推荐)
pnpm add -D @fxri/toolkit- 任务记录、校验、归档随仓库走,团队成员与 AI 会话内
pnpm exec toolkit(npm 用户npx toolkit)即可用 - 版本随项目锁定,升级由项目统一决定
方式二:全局安装
pnpm i -g @fxri/toolkit # pnpm(bin 落在 pnpm home,不受 nvm 切版本影响)
npm i -g @fxri/toolkit # npm(bin 硬链在 Node 目录,切版本需重装)
yarn global add @fxri/toolkit # 仅 yarn 1.x;v2+ 默认禁用 global,建议改用 pnpm
bun i -g @fxri/toolkit # bun适合个人在多个项目间快速使用。⚠️ 使用 nvm/fnm 等切换 Node 版本的工具时,npm 的全局包绑定在安装时的 Node 版本上,切版本后会「消失」——重新执行安装命令即可(pnpm 全局目录独立于 Node 版本,或用方式三规避)。
方式三:不安装、临时执行
pnpm dlx @fxri/toolkit tasks # pnpm
npx @fxri/toolkit tasks # npm / yarn
bunx @fxri/toolkit tasks # bun零安装先体验。⚠️ 首次执行有下载耗时,且每次都解析最新版本,不适合高频使用。
安装方式对比
| 方式一 devDep | 方式二 全局 | 方式三 临时执行 | |
|---|---|---|---|
| 团队共享版本 | ✅ 锁定 | ❌ 各装各的 | ❌ 总是最新 |
| 离线可用 | ✅ | ✅ | ❌ |
| nvm 切版本影响 | 无 | npm ⚠️ 需重装;pnpm ✅ 不受影响 | 无 |
| 推荐包管理器 | pnpm | pnpm | pnpm dlx |
| 适合场景 | 团队/长期项目 | 个人多项目 | 快速试用 |
关于 AI 技能包(skills)
本工具的完整工作流已沉淀为零依赖的 Agent Skills(纯 Markdown 规范),skills 可以独立工作,不装 CLI 也能让 AI 按同一套规范建档、校验、归档;CLI 提供的是自动校验、自动归档等加速。
- 推荐两者都装,体验最完整
- 只装 skills:AI 仍能跑通全流程(手工执行规范步骤)
- 只装 CLI:人可以用,但 AI 侧没有规范指引
安装 skills(两种方式,选一):
# 方式一:装了 CLI 一键分发(推荐,技能随包分发,与 CLI 同一发布批次)
pnpm add -g @fxri/toolkit && toolkit skills install # npm 用户:npm i -g @fxri/toolkit
# 项目面分发(团队推荐,技能随仓库入库、队友 clone 即用)
toolkit skills install --scope project # --scope 缺省时按 CLI 安装位置自动判定
# 方式二:上游安装器(技能走 GitHub 拉取,与 CLI 是两条供应链,易出现版本漂移)
pnpm dlx skills add fxri-net/toolkit --global # npm 用户:npx skills add fxri-net/toolkit --globaltoolkit skills install 默认软链真源、链接创建失败自动降级副本,另有 toolkit skills status(查现场)与 toolkit skills remove(卸载);--scope project 换项目面——真源落 <仓库根>/.agents/skills/、其余已存在的候选目录落入口薄壳,随 git 入库后队友 clone 即用(toolkit init 会写入 prepare 钩子,pnpm install 自动刷新);⚠️ 软链落点是写入穿透形态(改落点文件即改真源),要改技能内容请改真源,status 报告末尾也会提示;细节见完整攻略 · AI 技能包。
GitHub 拉不下来?国内网络走 Gitee 镜像渠道,内网 / 离线安装见 FAQ · 内网或离线环境怎么装。
30 秒上手
# 1. 初始化任务区(生成 .tasks/ 骨架、conventions/ 规范载体与技能入口壳,补齐 .gitignore 片段;项目本地依赖含 @fxri/toolkit 时写入 prepare 刷新钩子)
pnpm exec toolkit init
# 2. 查看任务总览(当前为空)
pnpm exec toolkit tasks
# 3. 方案确认后,把方案登记为任务文件(.tasks/active/202609/ 下)
# 文件名:{YYYYMMDD}-{用户名}-{任务简述}.md
# 手工建档模板见「完整攻略」;装了 AI 技能包可直接让 AI 建档
# 4. 校验
pnpm exec toolkit tasks check
# 5. 任务完成后:frontmatter 标记 status: 已完成 + completed 时间,然后归档
pnpm exec toolkit tasks archive
# 6.(可选,AI 协作时)归档后做任务级规范沉淀 → 能力终点⚠️ toolkit init 为 1.7.0 新增;旧版本请手工建 .tasks/active/{YYYYMM}/ 目录结构。
不想把
.tasks/放项目里?配置"tasks": { "dir": "../my-tasks-repo" }指向独立仓库(或每次用--dir传参),详见配置参考。
AI 用户(让 AI 替你操作)
不需要懂命令,直接对 AI 说:
- 「新项目,先初始化任务区」→ AI 跑
toolkit init建.tasks/骨架、conventions/规范载体与技能入口壳,并补齐.gitignore片段(项目本地依赖含@fxri/toolkit时写入prepare刷新钩子;逐项报告实际动作;1.7.0 新增命令) - 「把刚才确认的方案落盘为任务」→ AI 会在
.tasks/active/下建档 - 「任务做完了,归档」→ AI 归档任务并做任务级规范沉淀(终点;提交、发版、推送不是必经步骤,按你的规则约定)
- 「任务做完了,归档并提交」→ AI 先归档与沉淀、后提交,归档文件与代码变更同一 git 提交
- 「现在有哪些没做完的任务」→ AI 会跑总览给你
- 会话收尾说「会话要结束了,把结论记下来 / 今天先到这」→ AI 全量回放本会话 → 先给你核对任务清单 → 逐条落盘归档 + 规范沉淀(1.7.0 新增技能)
- 新会话开头说「恢复上下文 / 上次做到哪了」→ AI 读 active 全部与近期归档,接上上次现场(1.7.0 新增技能)
- 发现历史任务时间不准时说「修正历史任务时间」→ AI 取证给你逐条确认后修正(1.8.0 新增)
配好之后要管多少? 日常零操作:建档、校验、归档与规范沉淀全部由 AI 按全局规则自主完成,AI 干完会回报清单请你确认(防写错仓库文件的安全设计,不是操作负担)。仅三个时刻需要你出手:
- 首次安装:安装命令由你执行(AI 规则明确不自行全局安装)
- 升级:看到版本提示后执行升级命令并开新会话
- 工具不可用兜底:AI 会把方案完整输出到对话,由你手动保存
记录范围:只沉淀工作产出(功能改动、结论、决策及理由——决策散在对话里会话一关就丢);与产出无关的闲聊不记录;你明确说「把这句记下来」时 AI 照记。
前提是 AI 侧已装 skills(见上文)。术语对照:AI 说「建档」= 创建任务文件;「归档」= 移入 .tasks/archive/;「check」= 语法与规范校验。
