Skip to content

xxih/nano-spec

Repository files navigation

NanoSpec CLI

轻量、可扩展的 Spec 驱动工作流工具。用统一流程把需求落成可执行任务: brief -> spec -> plan -> execute

3 分钟上手

# 1) 安装
npm install -g nano-spec

# 2) 初始化(默认交互式选择 AI 工具)
nanospec init

# 3) 创建任务(可直接回车使用默认名“待命名”)
nanospec new

在 AI 工具中按顺序执行:

  • /spec.1-spec:生成规格说明
  • /spec.2-plan:生成实施方案与任务拆解
  • /spec.3-execute:执行任务并更新状态

/init 使用建议(已初始化项目):

  • 直接给出任务目标:/init 创建用户认证功能
  • 避免只输入 /init 或“创建任务”这类泛化描述,否则应先补充任务名与一句话目标

核心命令

命令 简写 说明
nanospec init [--assets <commands|skills|both>] [--scope <project|user>] nanospec i 初始化项目结构并同步资产(commands/skills)
nanospec new [name] nanospec n [name] 创建任务目录并设为当前任务;不带 name 时进入交互输入(默认“待命名”)
nanospec switch [name] nanospec s [name] 切换当前任务
nanospec status nanospec st 查看当前任务状态
nanospec sync [--adapter <name>] [--assets <commands|skills|both>] [--scope <project|user>] nanospec sy [--adapter <name>] 同步资产到 AI 工具目录
nanospec preset list/install/uninstall nanospec p ls/add/rm 预设包管理
nanospec config nanospec c 查看当前配置
nanospec config get/set/unset/list nanospec c g/s/u/ls 读写配置(支持 --global
nanospec -V, --version - 显示当前安装的 CLI 版本

工作流概览

  1. 需求:在 brief.mdprd.md 写清目标
  2. 规格:/spec.1-spec
  3. 规划:/spec.2-plan
  4. 执行:/spec.3-execute
  5. 对齐(出现需求变更、实现偏差或临时决策时立即执行):/spec.align
  6. 验收/总结(可选):/spec.accept/spec.summary

内置 Skill

内置统一 skill:nanospec。它的第一定位是 AI 工作中间文档的目录规范和 align 纠偏机制;在需要时,才进一步路由为完整的 spec-driven workflow(已合并 init/run/spec/align/plan/execute/accept/summary/onboard,内部按渐进披露加载 references)。

  • skill 文案已全部中文化。
  • skill 可脱离 nanospec CLI 运行;只要仓库里具备约定目录结构,就可以直接按文件推进。
  • 用户完全可以只采用这套目录规范,不使用 NanoSpec 的其他阶段能力。
  • 简单任务可以把截图、日志、接口样例、参考链接直接放在 assets/ 下;只有复杂任务才建议拆成 research/bugs/api/data/ui/references/ 等子目录。
  • alignment.md 不预创建,只有真正需要对齐时才补写。
  • 当其他 skill 采用“先 plan 后 xxx”模式时,只要装载了 nanospec skill,就应按这套目录规范读写中间文档。
  • 出现需求变化或实现偏差时,要先执行 align,再继续 spec / plan / execute,或继续其他已装载的 plan / research / execute skill。
  • align 是核心能力,不依赖完整 workflow 才能使用。
  • 使用这个 skill 时,也可以直接通过 /xxx 路由到对应阶段,例如 /align/plan/execute/run;如果团队仍使用 /spec.align/spec.2-plan 这类前缀命令,也保持兼容。
  • skill 自带 scripts/create_task_skeleton.py,可快速创建 nanospec/<YYYYMMDD-task-name>/ 骨架,并可选同步 .nanospec/.current
  • 最小任务结构:.nanospec/.current(可选)和 nanospec/<YYYYMMDD-task-name>/{brief.md,assets/,outputs/}alignment.md 按需出现。
  • 新建任务目录名必须使用 YYYYMMDD-任务主题 格式,例如 20260315-skills跨工具安装指南

安装 Skill(简版)

在 Codex(推荐,用户级):

直接用自然语言让 agent 安装即可(示例):

请帮我安装 nano-spec 的 nanospec skill,来源是 https://github.com/xxih/nano-spec/tree/main/src/static/skills/nanospec

nanospec sync --adapter codex --assets skills --scope user

或直接从 GitHub 安装:

$skill-installer install https://github.com/xxih/nano-spec/tree/main/src/static/skills/nanospec

安装后重启 Codex 生效。

在其它 AI agent 工具:

  1. 复制仓库中的 src/static/skills/nanospec/ 到该工具的 skills 目录。

预设包

内置预设:

  • frontend:前端开发
  • backend:后端开发
  • refactor:重构任务
  • docs:文档写作

示例:

nanospec preset list
nanospec preset install frontend

配置

默认配置文件在 .nanospec/config.json,也可使用 CLI 管理:

nanospec config list
nanospec config get default_adapter
nanospec config set default_adapter codex

常用配置项:specs_rootcmd_prefixdefault_adaptertemplate_formatauto_sync

新增配置项:

  • default_assets:默认同步资产类型(commands / skills / both
  • codex_scope:作用域配置(project / user),用于支持 scoped 目录的资产(如 codex skills、claude-codegemini
  • enabled_skills:仅同步指定 skills(JSON 数组;空数组表示全部内置 skills)

支持的 AI 工具

  • cursor
  • codex
    • commands~/.codex/prompts/(固定用户级;即使传 --scope project 也会回退到 user)
    • skills./.codex/skills/--scope project)或 ~/.codex/skills/--scope user
  • claude-code
    • commands./.claude/commands/--scope project)或 ~/.claude/commands/--scope user
    • skills./.claude/skills/--scope project)或 ~/.claude/skills/--scope user
  • gemini
    • commands./.gemini/commands/--scope project)或 ~/.gemini/commands/--scope user
  • qwen
  • iflow
  • cline
  • copilot
    • commands./.github/prompts/*.prompt.md
  • windsurf
  • kilo-code

项目结构

project-root/
├── .nanospec/
│   ├── AGENTS.md
│   ├── config.json
│   └── .current
├── nanospec/
│   └── <task-name>/
│       ├── brief.md
│       ├── assets/
│       │   └── README.md
│       ├── alignment.md         # 可选,发生偏差/变更时再创建
│       └── outputs/
│           ├── 1-spec.md
│           ├── 2-plan.md
│           └── 3-tasks.md
├── .<ai-tool>/commands/
├── .github/
│   └── prompts/
└── .codex/
    └── skills/

~/.codex/
└── prompts/

assets/ 用来放任务上下文。简单任务直接平铺即可;只有复杂任务才建议拆成 research/bugs/api/data/ui/references/ 等子目录,不要求一次性建全。

常见问题

nanospec init 后没有资产文件?

运行:

nanospec sync

如果使用了 --scope user,请检查对应用户目录(如 ~/.codex/*~/.claude/*~/.gemini/*)。 注意:codex 的 commands 固定写入 ~/.codex/prompts/

如何继续上次任务?

nanospec status
nanospec switch

维护者信息

  • 变更记录:CHANGELOG.md
  • 内部开发指南:guides/README.md

License

MIT

About

A minimal extendable Spec-Driven framework. Not just for code -- for writing, research, and anything you want to get done.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors