FastAPI Admin Skills

一键安装 FastAPI Admin 开发规范到你的 AI 编辑器。

支持的 AI 编辑器

| 编辑器 | 规则目录 | |--------|----------| | Cursor | .cursor/rules/ | | Kiro | .kiro/steering/ | | Antigravity | .agent/skills/ | | Qoder | .qoder/rules/ | | CodeBuddy | .codebuddy/ | | Windsurf | .windsurfrules |

快速开始

# 安装 Skills 到当前项目（自动检测编辑器）
npx fastapi-admin-skills init

# 指定编辑器
npx fastapi-admin-skills init --editor cursor
npx fastapi-admin-skills init --editor kiro
npx fastapi-admin-skills init --editor antigravity

可用命令

# 初始化（安装所有 Skills）
npx fastapi-admin-skills init

# 列出可用 Skills
npx fastapi-admin-skills list

# 安装单个 Skill
npx fastapi-admin-skills add crud-generator

Skills 列表

| Skill | 说明 | |-------|------| | fastapi-admin-core | 项目核心规范（结构、命名、代码风格） | | crud-generator | CRUD 代码生成模板 | | database-orm | Tortoise ORM 与自动迁移 | | scheduler-setup | APScheduler 定时任务 | | multi-tenant | 多租户数据隔离 |

使用示例

安装完成后，你可以这样提问 AI：

"帮我创建一个商品管理模块"
"这个项目的 API 规范是什么？"
"怎么添加一个每天凌晨2点执行的任务？"
"怎么给模块添加多租户支持？"

AI 会根据安装的规则自动生成符合项目规范的代码。

命令选项

npx fastapi-admin-skills init [options]

Options:
  -e, --editor <editor>  指定编辑器 (cursor/kiro/antigravity/qoder/codebuddy/windsurf)
  -f, --force           强制覆盖已存在的文件
  -h, --help            显示帮助信息

本地开发

# 克隆仓库
git clone https://github.com/your-username/fastapi-admin-skills.git
cd fastapi-admin-skills

# 安装依赖
npm install

# 本地测试
node bin/cli.js init --editor cursor

License

MIT