# ai

**Repository Path**: idcu/ai

## Basic Information

- **Project Name**: ai
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-06-06
- **Last Updated**: 2026-06-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# AI 开发提效框架

Agent + Skills 体系，为 AI 开发提效省 token。

---

## 🚀 立即开始

### 📚 必读文档（开始前看）

| 文档 | 说明 | 谁看 |
|-----|------|-----|
| **[GETTING_STARTED.md](GETTING_STARTED.md)** | ✨ **强烈推荐！** 完整的「如何使用本框架」指南 | 新用户 |
| [INDEX.md](INDEX.md) | Skill 索引 | 找 Skill 的时候 |
| [USAGE_GUIDE.md](USAGE_GUIDE.md) | 详细使用指南 | 深入学习 |
| [QUICK_REFERENCE_CARD.md](QUICK_REFERENCE_CARD.md) | 一页纸快速参考 | 日常开发速查 |
| [AGENTS.md](AGENTS.md) | 项目规则（自动生成） | 日常工作 |

### 📖 进阶参考文档

| 文档 | 说明 |
|-----|------|
| [docs/AI_TOOLS_INTEGRATION.md](docs/AI_TOOLS_INTEGRATION.md) | 🤖 与主流 AI 代码工具配合（Copilot/Cursor/Continue/...） |

### 安装依赖

```bash
npm install
```

### 首次使用步骤

```bash
# 1. 同步元数据（必须！）
npm run sync-meta

# 2. 生成 AGENTS.md
npm run generate-agents

# 3. 查看有哪些 Skill
npm run skill-list

# 4. 你已经准备好了！看 GETTING_STARTED.md 开始使用！
```

---

## 📋 项目结构

```
├── README.md            # 本文件
├── GETTING_STARTED.md   # ✨ 新手指南（必看！）
├── AGENTS.md            # 项目规则（自动生成）
├── INDEX.md             # Skill 系统索引
├── USAGE_GUIDE.md       # 完整使用指南
├── QUICK_REFERENCE_CARD.md # 一页纸快速参考
│
├── docs/                # 进阶参考文档
│   └── AI_TOOLS_INTEGRATION.md
│
├── meta/                # 元数据
├── skills/              # Skill 库（47 个 Skill，多维度结构）
├── .tmp/               # 统一临时文件目录（git 忽略）
│   ├── plans/        # 临时计划文档
│   ├── scratch/       # 草稿
│   ├── exports/      # 导出文件
│   ├── backups/      # 备份
│   └── test/        # 测试
├── specs/               # Spec 模板
├── tools/               # 工具脚本（14 个工具）
├── examples/            # 使用示例
├── retrospectives/      # 复盘历史
├── .husky/              # Git hooks
└── .github/             # CI/CD
```

---

## 🎯 功能特性

- ✅ **47 个 Skill**（多维度结构：全局/语言/框架/工具链/项目/领域/阶段/团队）
  - 21 个全局通用 Skill（新增 ai-skill-suggestion）
  - 6 个语言特定 Skill（Python、JavaScript、TypeScript）
  - 4 个框架特定 Skill（React、Vue、Next.js、NestJS）
  - 15 个工具链 Skill（npm、Vite、ESLint、Jest、Prettier、Husky、Trae、Docker、GraphQL、Prisma、Tailwind）
  - 1 个项目层示例 Skill
- ✅ **统一临时文件管理**
  - `.tmp/` 目录统一管理所有临时文档（plans、scratch、exports、backups、test
  - 简化的 .gitignore 配置
- ✅ **增强版 Skill 索引系统**（类似 Redis 的快速查找）
  - byName, byPath, byTag, byCategory, byScope, byLanguage, byFramework, byToolchain, byProject 多维索引
  - `npm run skill-search` 强大的搜索工具
- ✅ **项目配置与缓存系统**
  - `.ai/config.json` 项目配置（标签、语言、框架等）
  - Skill 推荐与缓存机制，支持多维度匹配
- ✅ 13 个管理工具
- ✅ 12 个模板文档（Plan、Spec、复盘）
- ✅ Git hooks 集成（自动测试、提交规范）
- ✅ GitHub Actions CI/CD 配置
- ✅ Skill 自我进化系统（使用统计、成功率、反馈）
- ✅ 文档管理与临时文档清理功能
- ✅ 完整的使用示例
- ✅ 多维度 Skill 系统，支持多项目多语言共享和演进

---

## 📚 Skill 分类

### 按维度分类

| 维度 | 数量 | 说明 |
|------|------|------|
| **Global** | 20 | 全局通用 Skill |
| **Language** | 6 | 语言特定 Skill |
| **Framework** | 3 | 框架特定 Skill (React、Vue、Next.js) |
| **Toolchain** | 11 | 工具链 Skill (npm、Vite、ESLint、Jest、Prettier、Husky、Trae) |
| **Project** | 1 | 项目特定 Skill |

### 按功能分类

| 分类 | 数量 | 说明 |
|------|------|------|
| **Core** | 6 | 执行操作的 Skill |
| **Guide** | 24 | 指南和最佳实践 |
| **Template** | 4 | 模板类型的 Skill |
| **Chain** | 2 | 技能链（预定义工作流） |

---

## 🛠️ 可用脚本

### Skill 搜索（新增！）

```bash
# 强大的 Skill 搜索（新增！）
npm run skill-search -- help                  # 查看帮助
npm run skill-search -- name <skill-name>      # 按名称查找
npm run skill-search -- tags <tag1> <tag2>    # 按标签查找
npm run skill-search -- category <category>   # 按分类查找
npm run skill-search -- scope <scope>         # 按作用域查找
npm run skill-search -- language <lang>       # 按语言查找
npm run skill-search -- desc <keyword>        # 按描述关键词查找
npm run skill-search -- search <query>        # 模糊搜索
npm run skill-search -- all                   # 列出所有
```

### Skill 管理

```bash
# 创建新 Skill
npm run skill-scaffold -- --name <name> --description <desc> --category <category>

# 导出 Skill
npm run skill-export

# 列出所有 Skill
npm run skill-list

# 查看推荐
npm run skill-recommend

# 按语言查看推荐（重要！）
npm run skill-recommend -- language python
npm run skill-recommend -- language javascript

# 按作用域查看
npm run skill-recommend -- scope language
npm run skill-recommend -- scope global

# 提升 Skill 作用域（局部 → 全局）
npm run skill-promote -- <skill-path> <target-scope>

# 测试 Skill
npm run skill-test

# 版本管理
npm run skill-version

# 查看统计
npm run skill-stats
```

### 项目配置（新增！）

```bash
# 项目配置与 Skill 推荐（新增！）
npm run project-config  # 在你的项目根目录运行，生成 Skill 推荐
# 需要在你的项目中创建 .ai/config.json
```

### 文档管理

```bash
# 查看哪些文档会被清理（不实际删除）
npm run doc-cleanup:dry

# 清理超过 30 天的临时文档
npm run doc-cleanup

# 归档（而不是删除）
npm run doc-cleanup:archive
```

### 元数据管理

```bash
# 同步 Skill 元数据
npm run sync-meta

# 生成 AGENTS.md
npm run generate-agents
```

---

## 💡 快速使用示例

### 开发新功能

1. 使用 `feature-dev-flow` 技能链
2. 或参考 [examples/feature-development.md](examples/feature-development.md)

### 修复 Bug

1. 使用 `bug-fix-flow` 技能链
2. 或参考 [examples/bug-fix.md](examples/bug-fix.md)

### 创建新 Skill

参考 [examples/skill-scaffold-example.md](examples/skill-scaffold-example.md)

---

## 📦 两种使用方式

| 方式 | 适用场景 |
|------|----------|
| **独立仓库** | 把本项目作为你所有项目的工具/技能库 |
| **集成到你的项目** | 在特定项目中使用框架 |

详情看：[GETTING_STARTED.md](GETTING_STARTED.md)

---

## License

MIT