create-agent-native-project
v0.1.2
Published
An AI-native scaffold for single projects, Turborepo, and Nx workspaces.
Maintainers
Readme
create-agent-native-project
一个零依赖的最简 AI-native 项目脚手架。它不生成业务代码,只为现有或新项目注入 Agent 协作流程和可持续维护的文档基础。
推荐用法
# 推荐:交互式向导
npm create agent-native-project@latest
# 注入当前项目
npm create agent-native-project@latest .
# 指定项目目录
npm create agent-native-project@latest ./my-projectnpm create agent-native-project 会按 npm 的约定执行 create-agent-native-project 包。也可以直接使用:
npx create-agent-native-project@latest ./my-project向导会直接询问项目类型,没有额外的 Monorepo 中间层:
? Select a project type
○ Single project
○ Turborepo
○ Nx选择 Turborepo 或 Nx 时,初始化器会先调用官方生成器,再注入适合 Monorepo 的 AGENTS.md 和架构文档。
命令行参数
-y, --yes 使用安全默认值,不进行询问
-f, --force 覆盖已有的脚手架管理文件
--dry-run 预览将要执行的操作,不写文件
--project-type 项目类型:single、turborepo 或 nx
--ui <skill> UI Skill:none、frontend-design 或 impeccable
--api <skill> API Skill:none 或 api-designer
--no-interactive 关闭交互,使用安全默认值
-h, --help 显示帮助
-v, --version 显示版本npm 7+ 中向初始化器传递参数时,在参数前加 --:
npm create agent-native-project@latest . -- --dry-run
npm create agent-native-project@latest . -- --yes
npm create agent-native-project@latest . -- --force
npm create agent-native-project@latest ./my-project -- --project-type turborepo
npm create agent-native-project@latest . -- --ui frontend-design
npm create agent-native-project@latest . -- --api api-designer默认不覆盖已有文件。--yes 不代表允许覆盖;覆盖必须显式使用 --force。
生成结构
AGENTS.md
docs/
README.md
bootstrap.md
product.md
architecture.md
plans/AGENTS.md负责工作流程、高影响决策门禁、文档/Skill 影响检查和知识沉淀顺序。docs/README.md是文档索引,说明每类文档的读取时机、事实源和生命周期。docs/bootstrap.md是一次性项目启动协议:Agent 先检查仓库,再向用户询问无法推断的关键问题。docs/product.md保存产品目标与边界。docs/architecture.md保存系统边界与长期约束。docs/plans/保存进行中功能的临时设计和验收标准。
docs/decisions/ 和 docs/runbooks/ 不会预先生成,只在项目真正产生相应知识时创建。
首次项目对齐
初始化完成后,在 Coding Agent 中输入:
Read AGENTS.md and help me bootstrap this project.Agent 会先读取现有代码、配置和文档,再分批询问产品目标、首个可用成果和必要约束。已经能从项目中推断的框架和技术栈不会重复询问。对齐完成后,结论写入 product.md 和 architecture.md,bootstrap.md 默认删除,避免后续 Agent 重复执行。
项目类型
single:只注入 AI-native 协作层,不生成业务代码。turborepo:使用官方create-turbo生成工作区。nx:使用官方create-nx-workspace生成工作区。
Monorepo 版本会将以下内容写入文档:
- 应用与共享包的职责、所有权和依赖方向。
- 受影响工作区的定向验证方式。
- 公开入口、共享契约和跨包变更规则。
- 在仓库根目录调用官方生成器新增
apps/<name>或packages/<name>的流程。
对已有项目,存在 turbo.json 或 nx.json 时只注入协作层,不重复运行生成器。为了避免破坏现有项目,非空目录缺少对应标记文件时会拒绝初始化。
可选 UI Skill
交互式向导会提供:
none:不安装 UI Skill,也是非交互模式的默认值。frontend-design:通过 Skills CLI 安装 Anthropic Frontend Design。impeccable:通过官方 CLI 安装完整 Impeccable 设计工作流。
# 轻量 UI 设计指导
npm create agent-native-project@latest . -- --ui frontend-design
# 完整 UI 设计工作流
npm create agent-native-project@latest . -- --ui impeccable初始化器不复制上游文件,而是调用对应工具的官方安装器。安装器可能继续询问需要安装到哪个 Coding Agent。Impeccable 安装后还需在 Agent 中执行 /impeccable init。
可选 API Skill
none:不安装 API Skill,也是非交互模式的默认值。api-designer:安装 API Designer,用于资源建模、OpenAPI 3.1 规范、校验、Mock 和版本策略。
npm create agent-native-project@latest . -- --api api-designer可以同时选择 UI 和 API Skill:
npm create agent-native-project@latest . -- --ui frontend-design --api api-designer本地开发
npm test
npm run pack:check
node ./bin/create-agent-native-project.js ./tmp-example发布
发布前先确认 package.json 中的包名在 npm 可用,然后执行:
npm login
npm publish --access public