Keel · @ziye001/keel-starter

一行命令，给任意项目铺上 AI 编码地基 — AGENTS.md、Skills、Rules、Quickstart。

npx @ziye001/keel-starter init -y

装好即用：Cursor 打开项目 → 复制 docs/keel-quickstart.md 里的第一句话。

English: Scaffold AI coding workflow (AGENTS.md, skills, verify hooks) into any repo.

npx @ziye001/keel-starter init -y   # solo preset, safe overwrite defaults
keel doctor                          # health check + sample prompt

安装

# 推荐：零全局安装
npx @ziye001/keel-starter init -y

# 或全局
npm install -g @ziye001/keel-starter
keel init -y

国内镜像（仅安装）：

npm install -g @ziye001/keel-starter --registry https://registry.npmmirror.com

个人开箱（推荐）

cd your-project
keel plan          # 可选：先看会动哪些文件
keel init          # 交互，默认「个人开箱」
keel init -y       # 一路回车，等同 --preset solo

solo 预设：Cursor + 核心 Skills + docs/keel-quickstart.md，默认不覆盖已有 AGENTS.md。

命令

| 命令 | 说明 | |------|------| | keel | 常用命令速览 | | keel init | 安装（交互默认个人开箱） | | keel plan | 预览安装，不写入 | | keel upgrade | 按 .keel/config.json 同步模板 | | keel doctor | 检查安装 + 下一步建议 | | keel list presets | 查看 solo / react-admin 等预设 |

示例

keel init -y
keel init --preset react-admin --overwrite
keel plan --dir ./my-app
keel doctor --json

upgrade / doctor

keel upgrade --dir ./my-project
keel doctor
keel list platforms

支持的平台

| 平台 | ID | 安装路径 | |------|-----|----------| | Cursor | cursor | .agents/skills、.cursor/agents、.cursor/rules | | Claude Code | claude | .claude/skills | | Windsurf | windsurf | .windsurf/skills、.windsurf/rules | | Cline | cline | .cline/skills、.clinerules/ | | Roo Code | roo | .roo/skills、.roo/rules | | GitHub Copilot | copilot | .github/copilot-instructions.md | | Continue | continue | .continue/rules | | OpenCode / 通用 | opencode | AGENTS.md、.agents/skills |

配置文件

安装后生成 .keel/config.json，记录模板、平台、Skills 模块与项目变量。keel upgrade 据此同步。

维护者

cd packages/keel-starter
npm login --registry https://registry.npmjs.org
npm run publish:npm

npm：https://www.npmjs.com/package/@ziye001/keel-starter

录制动图（docs/keel-demo.gif）

cd your-empty-project
npx @ziye001/keel-starter init -y
keel doctor

用 Windows 自带录屏 / Peek / asciinema 导出 约 30 秒 GIF，保存为 packages/keel-starter/docs/keel-demo.gif 后 push。

本地开发

cd packages/keel-starter
npm install && npm test

其他安装

git clone https://gitee.com/ziye001/svg-parent.git
cd svg-parent/packages/keel-starter && npm i && npm i -g .

License

MIT