f2e-ai
v0.1.4
Published
Frontend AI workflow CLI for initializing project-local f2e-ai conventions and skills.
Downloads
105
Readme
f2e-ai
一个用于前端 AI 协作流程初始化的 CLI 工具。
当前版本聚焦一个命令:f2e-ai init,用于在项目中落地 .f2e-ai 规范目录、模板和多平台技能包。
功能概览
- 初始化
.f2e-ai工作流文件与模板 - 按 AI 平台分发内置 skills
- 支持已存在文件跳过/强制覆盖
环境要求
- Node.js
>=20
安装
1) 全局安装(推荐)
npm install -g f2e-ai
f2e-ai init --ai all2) 在业务项目中安装并使用
npm install -D f2e-ai
npx f2e-ai init --ai all也可用 pnpm / yarn:
pnpm add -D f2e-ai
pnpm f2e-ai init --ai all3) 本仓库开发安装
npm install
npm run build使用方式
f2e-ai init [--ai <platform>] [--target <dir>] [--force]也可在本仓库直接运行:
node bin/f2e-ai.js init --ai all --target .参数说明
--ai:目标平台,支持cursor | claude | codex | antigravity | all,默认all--target:目标目录,默认当前工作目录--force:覆盖已存在文件(默认不覆盖)
支持平台与技能目录
cursor->.cursor/skills/claude->.claude/skills/codex->.codex/skills/antigravity->.agent/skills/
初始化后会生成什么
工作流文件
.f2e-ai/plans/f2e-workflow.md.f2e-ai/templates/requirement.md.example.f2e-ai/templates/change-summary.md.example.f2e-ai/requirements/(目录)
内置 skills
会按所选平台复制以下 skills:
f2e-ai-code-analyst:分析项目技术栈、结构与规范,产出.f2e-ai/handbook/。f2e-ai-requirement-analyst:将需求/任务/Figma/API 信息澄清并沉淀到.f2e-ai/requirements/<id>/。f2e-ai-write-plan:基于requirement-id先产出测试用例,再生成可执行plan.md。f2e-ai-execute-plan:按确认后的plan.md执行实现,控制范围并处理执行中的失败与决策点。f2e-ai-i18n-translate:扫描改动文件中的中文,生成 i18n key,替换源码并更新语言包。f2e-ai-e2e-test:执行 Playwright 测试并将结果写入test-result.md。f2e-ai-commit:汇总改动并写change-summary.md,随后完成提交、推送与 PR 准备。
开发命令
npm test
npm run build项目结构(核心)
bin/ # CLI 可执行入口
src/cli/ # 命令行解析与分发
src/core/ # 约定与 init 核心逻辑
src/skills/ # skills 源文件
src/templates/ # 模板源文件
dist/ # 构建产物(编译代码 + 拷贝后的 skills/templates)
tests/ # 测试License
ISC
