# aitools

**Repository Path**: konghy/aitools

## Basic Information

- **Project Name**: aitools
- **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-03-07
- **Last Updated**: 2026-03-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# aitools

个人 AI 辅助工具集，包含 Cursor 和 Claude Code 可用的规则（Rules）与技能（Skills）配置。

## 目录结构

```
aitools/
├── clauderules/                 # Claude Code 全局规则（对应 ~/.claude/）
│   ├── CLAUDE.md                # Claude 规则主入口
│   └── rules/
│       ├── coding-best-practices.md
│       ├── git-conventions.md
│       ├── python-coding-standards.md
│       ├── system-safety-common.md
│       ├── system-safety-unix.md
│       └── system-safety-windows.md
│
├── config/
│   └── command-allowlist.txt  # Cursor Command Allowlist
│
├── rules/          # Cursor 全局规则（对应 ~/.cursor/rules/）
│   ├── coding-best-practices.mdc   # 编码最佳实践
│   ├── git-conventions.mdc         # Git 使用规范
│   ├── python-coding-standards.mdc # Python 编码规范
│   ├── system-safety-common.mdc    # 系统操作安全规范（通用）
│   ├── system-safety-unix.mdc      # Unix/Linux/macOS 系统安全规范
│   ├── system-safety-windows.mdc   # Windows 系统安全规范
│   └── tool-navigator.mdc          # 工具使用问答规范
│
└── skills/         # 通用 AI Agent Skills 内容
    ├── article-writing/           # 技术文章与文学写作指导
    ├── backend-models-standards/  # 数据库模型规范
    ├── code-quality-review/       # 代码审查综合技能
    ├── context-optimization/       # 上下文优化技术
    ├── doc-coauthoring/           # 文档协作撰写工作流
    ├── shell-scripting/           # Shell 脚本编写最佳实践
    └── systematic-debugging/      # 系统化调试方法论
```

## Cursor Rules 说明

`rules/` 是 Cursor 的持久化指导规则，放在 `~/.cursor/rules/` 后对所有项目生效。

| 文件 | 说明 |
|------|------|
| `coding-best-practices.mdc` | 代码复用、质量、错误处理、性能、安全等通用原则 |
| `git-conventions.mdc` | Commit 格式、分支命名、.gitignore 规范 |
| `python-coding-standards.mdc` | Python 代码风格、类型注解、文档规范 |
| `system-safety-common.mdc` | 危险命令警示、文件删除安全、权限管理等（通用） |
| `system-safety-unix.mdc` | Unix/Linux/macOS 环境下的 Shell、权限、路径等安全规范 |
| `system-safety-windows.mdc` | Windows 环境下的 PowerShell、注册表、路径等安全规范 |
| `tool-navigator.mdc` | Git、Shell、Docker 等工具使用问答规范 |

## Claude Rules 说明

`clauderules/` 是 Claude Code 的全局规则目录，使用时将其内容复制到 `~/.claude/`。

`clauderules/CLAUDE.md` 是规则主入口，包含行为偏好和规则导入：
- **常驻规则**：编码实践、Git 规范、系统安全，始终生效
- **可选规则**：Python 编码、Unix/Windows 安全，按需在项目级 CLAUDE.md 中引用

| 文件 | 说明 |
|------|------|
| `clauderules/CLAUDE.md` | 规则主入口（行为偏好 + 规则导入） |
| `clauderules/rules/coding-best-practices.md` | 通用编码最佳实践（常驻） |
| `clauderules/rules/git-conventions.md` | Git 提交、分支、`.gitignore` 规范（常驻） |
| `clauderules/rules/system-safety-common.md` | 通用系统操作安全规范（常驻） |
| `clauderules/rules/python-coding-standards.md` | Python 编码规范（可选） |
| `clauderules/rules/system-safety-unix.md` | Unix/Linux/macOS 安全规范（可选） |
| `clauderules/rules/system-safety-windows.md` | Windows 安全规范（可选） |

## Skills 说明

`skills/` 存放通用 skill 内容，正文尽量保持同时兼容 Cursor 与 Claude Code。

说明：
- 对 Cursor，可复制到 `~/.cursor/skills/`
- 对 Claude Code，可复制到 `~/.claude/skills/`
- 仓库中的 `skills/` 是内容源，不依赖某一平台专属目录结构

| 目录 | 触发场景 | 说明 |
|------|---------|------|
| `article-writing` | 技术文章写作、博客草稿润色、散文随笔创作时 | 技术文章与文学作品写作指导 |
| `backend-models-standards` | 创建/修改数据库模型、ORM、Schema 时 | 命名、类型、约束、关系、验证等模型规范 |
| `code-quality-review` | 审查代码变更、执行质量标准时 | 正确性、设计、可读性、安全性、性能等综合审查 |
| `context-optimization` | 提到上下文优化、token 成本、KV 缓存等 | 上下文压缩、遮蔽、分区等优化技术 |
| `doc-coauthoring` | 写文档、起草提案、创建规范时 | 协作文档撰写的结构化工作流 |
| `shell-scripting` | 编写 Shell 脚本时 | 防御性编程、ShellCheck 合规、安全实践 |
| `systematic-debugging` | 遇到 bug、测试失败、意外行为时 | 四阶段系统化调试方法，强制根因分析 |

## 配置备份

`config/` 目录存放各类配置备份，详见 [config/README.md](config/README.md)。

| 文件 | 说明 |
|------|------|
| `config/command-allowlist.txt` | Cursor Command Allowlist，每行一个命令，逗号结尾 |

## 安装使用

### 安装 Cursor Rules

将 `rules/` 目录下的 `.mdc` 文件复制到 `~/.cursor/rules/`：

```bash
cp rules/*.mdc ~/.cursor/rules/
```

### 安装 Claude Rules

将 `clauderules/` 目录下的内容复制到 `~/.claude/`：

```bash
cp clauderules/CLAUDE.md ~/.claude/CLAUDE.md
cp -r clauderules/rules ~/.claude/rules
```

### 安装 Skills 到 Cursor

将 `skills/` 下的各子目录复制到 `~/.cursor/skills/`：

```bash
cp -r skills/* ~/.cursor/skills/
```

安装后重启 Cursor 即可生效。

### 安装 Skills 到 Claude Code

将 `skills/` 下的各子目录复制到 `~/.claude/skills/`：

```bash
cp -r skills/* ~/.claude/skills/
```

### 项目级使用

Cursor 项目级使用：

```bash
cp -r skills/systematic-debugging your-project/.cursor/skills/
```

Claude Code 项目级使用：

```bash
cp -r skills/systematic-debugging your-project/.claude/skills/
```

## Skills 来源

| Skill | 来源 |
|-------|------|
| `systematic-debugging` | [obra/superpowers](https://github.com/obra/superpowers)（已翻译为中文并精简） |
| `context-optimization` | [muratcankoylan/context-optimization](https://github.com/muratcankoylan/context-optimization) |
| `shell-scripting` | 自定义 |
| `article-writing` | 自定义 |
| `code-quality-review` | 自定义 |
| `backend-models-standards` | 自定义 |
| `doc-coauthoring` | 自定义 |

## 参考资料

- [Cursor Rules 文档](https://docs.cursor.com/context/rules)
- [Agent Skills 介绍](https://docs.cursor.com/context/skills)
- [SkillHub - Skills 社区](https://www.skillhub.club/)
- [obra/superpowers](https://github.com/obra/superpowers)