@wneng/create-keel

Scaffolder for Contract First + Vibe Coding projects following the keel conventions (see root AGENTS.md).

完整中文安装与使用指南：docs/03-工程规范与研发基础设施/keel-getting-started.md（13 节，含三档采用策略、工程规范四大类、AI 访问模式、常见故障排查）。

TL;DR

# Quickstart：创建项目（交互式）
npx @wneng/create-keel create my-app

# 推荐第一次试用：带完整样例特性
npx @wneng/create-keel create demo --yes --sample-feature

# 给已有项目加特性
cd my-app
npx @wneng/create-keel feature add user-signup

# 完整档（To B 多客户交付）
npx @wneng/create-keel create my-full \
  --backend java --frontend react --mobile flutter --miniapp wechat \
  --agent rust-desktop --deploy kubernetes --contract rest+events \
  --ai kiro --license apache-2.0 --gitLfs --integrations \
  --ci github --roles qa,field,data,legal-security,marketing,design \
  --engineering-standards full \
  --yes

Usage

Create a new project

npx @wneng/create-keel create my-app

Add a feature to an existing project

cd my-app
npx @wneng/create-keel feature add user-signup

This scaffolds aligned PRD / ADR / backend / frontend / test artifacts plus a contract path stub, all sharing the same kebab-case slug. See docs/03-工程规范与研发基础设施/usage-quickstart.md (in the parent repo) for the full slug convention.

Try a worked example

npx @wneng/create-keel create demo --yes --sample-feature

Adds the user-signup feature with fully written PRD, ADR, designs, test plan, and /users/signup OpenAPI path so new users can read a working end-to-end example instead of empty templates.

Options for both subcommands are collected interactively when omitted. See --help.

Development

npm install
npm run build
npm test

See .kiro/specs/project-scaffolder/ in the parent repo for full design artifacts.

Source

• Gitee: https://gitee.com/wangneng521/keel
• npm: https://www.npmjs.com/package/@wneng/create-keel
• Spec: .kiro/specs/project-scaffolder/