feat: Update documentation and claude-skills module
This commit is contained in:
parent
489f87b251
commit
8830a20cc5
|
|
@ -0,0 +1,53 @@
|
||||||
|
# 快速备份工具
|
||||||
|
|
||||||
|
基于 `.gitignore` 规则的项目备份工具,自动排除不需要的文件。
|
||||||
|
|
||||||
|
## 功能特性
|
||||||
|
|
||||||
|
- 自动读取 `.gitignore` 规则
|
||||||
|
- 支持取反规则(`!` 语法)
|
||||||
|
- 目录级剪枝优化
|
||||||
|
- 生成 `.tar.gz` 压缩包
|
||||||
|
- 零依赖(仅使用 Python 内置模块)
|
||||||
|
|
||||||
|
## 文件结构
|
||||||
|
|
||||||
|
```
|
||||||
|
backups/
|
||||||
|
├── 快速备份.py # 核心备份引擎
|
||||||
|
├── 一键备份.sh # Shell 启动脚本
|
||||||
|
└── README.md # 本文档
|
||||||
|
```
|
||||||
|
|
||||||
|
## 使用方法
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 方式一:Shell 脚本(推荐)
|
||||||
|
bash backups/一键备份.sh
|
||||||
|
|
||||||
|
# 方式二:直接运行 Python
|
||||||
|
python3 backups/快速备份.py
|
||||||
|
|
||||||
|
# 指定输出文件
|
||||||
|
python3 backups/快速备份.py -o my_backup.tar.gz
|
||||||
|
|
||||||
|
# 指定项目目录
|
||||||
|
python3 backups/快速备份.py -p /path/to/project
|
||||||
|
```
|
||||||
|
|
||||||
|
## 输出位置
|
||||||
|
|
||||||
|
默认输出到 `backups/gz/备份_YYYYMMDD_HHMMSS.tar.gz`
|
||||||
|
|
||||||
|
## 参数说明
|
||||||
|
|
||||||
|
| 参数 | 说明 | 默认值 |
|
||||||
|
|------|------|--------|
|
||||||
|
| `-p, --project` | 项目根目录 | 当前目录 |
|
||||||
|
| `-o, --output` | 输出文件路径 | `backups/gz/备份_时间戳.tar.gz` |
|
||||||
|
| `-g, --gitignore` | gitignore 文件路径 | `.gitignore` |
|
||||||
|
|
||||||
|
## 依赖
|
||||||
|
|
||||||
|
- Python 3.x(无需额外包)
|
||||||
|
- Bash(用于 Shell 脚本)
|
||||||
|
|
@ -0,0 +1,105 @@
|
||||||
|
# 📖 文档库 (Documents)
|
||||||
|
|
||||||
|
`documents/` 目录汇总项目的流程文档、架构说明、开发经验与最佳实践,是理解方法论与协作规则的首选入口。当前包含 **14 个**文档。
|
||||||
|
|
||||||
|
## 目录结构
|
||||||
|
|
||||||
|
```
|
||||||
|
documents/
|
||||||
|
├── README.md # 本文件
|
||||||
|
│
|
||||||
|
├── # === 方法论与理念 ===
|
||||||
|
├── 编程之道.md # 编程哲学与核心理念(5.4KB)
|
||||||
|
├── 胶水编程.md # 胶水编程方法论(4KB)
|
||||||
|
├── gluecoding.md # Glue Coding 英文版(5.2KB)
|
||||||
|
├── 小登论道.md # 学习经验分享
|
||||||
|
│
|
||||||
|
├── # === 开发实践 ===
|
||||||
|
├── 开发经验.md # 变量命名、编码规范、架构原则(5KB)
|
||||||
|
├── 代码组织.md # 代码结构与组织方式(1.7KB)
|
||||||
|
├── vibe-coding-经验收集.md # AI 开发最佳实践(2.3KB)
|
||||||
|
├── 通用项目架构模板.md # 项目目录结构模板(13KB)⭐推荐
|
||||||
|
│
|
||||||
|
├── # === 工具与配置 ===
|
||||||
|
├── 工具集.md # 开发工具推荐
|
||||||
|
├── auggie-mcp配置文档.md # Augment 上下文引擎配置(2.7KB)
|
||||||
|
├── tmux快捷键大全.md # tmux 终端复用快捷键(1.1KB)
|
||||||
|
├── 关于手机ssh任意位置链接本地计算机,基于frp实现的方法.md # FRP 内网穿透(10.6KB)
|
||||||
|
│
|
||||||
|
├── # === 提示词与 AI ===
|
||||||
|
├── 系统提示词构建原则.md # 系统提示词设计指南(5.6KB)
|
||||||
|
│
|
||||||
|
└── # === 学习资源 ===
|
||||||
|
└── 编程书籍推荐.md # 编程书籍推荐列表(6KB)
|
||||||
|
```
|
||||||
|
|
||||||
|
## 文档分类
|
||||||
|
|
||||||
|
### 🧘 方法论与理念
|
||||||
|
|
||||||
|
| 文档 | 大小 | 说明 |
|
||||||
|
|------|------|------|
|
||||||
|
| `编程之道.md` | 5.4KB | 编程哲学、核心理念、思维方式 |
|
||||||
|
| `胶水编程.md` | 4KB | 胶水编程方法论(中文) |
|
||||||
|
| `gluecoding.md` | 5.2KB | Glue Coding 方法论(英文) |
|
||||||
|
| `小登论道.md` | 0.2KB | 个人学习经验分享 |
|
||||||
|
|
||||||
|
### 💻 开发实践
|
||||||
|
|
||||||
|
| 文档 | 大小 | 说明 |
|
||||||
|
|------|------|------|
|
||||||
|
| `通用项目架构模板.md` | 13KB | ⭐ 多种项目类型的标准目录结构、设计原则、技术选型 |
|
||||||
|
| `开发经验.md` | 5KB | 变量命名、文件结构、编码规范、微服务、Redis、消息队列 |
|
||||||
|
| `代码组织.md` | 1.7KB | 代码结构与组织方式 |
|
||||||
|
| `vibe-coding-经验收集.md` | 2.3KB | AI 开发最佳实践与系统提示词优化技巧 |
|
||||||
|
|
||||||
|
### 🔧 工具与配置
|
||||||
|
|
||||||
|
| 文档 | 大小 | 说明 |
|
||||||
|
|------|------|------|
|
||||||
|
| `auggie-mcp配置文档.md` | 2.7KB | Augment 上下文引擎 MCP 配置 |
|
||||||
|
| `tmux快捷键大全.md` | 1.1KB | tmux 终端复用快捷键速查 |
|
||||||
|
| `关于手机ssh...frp实现的方法.md` | 10.6KB | FRP 内网穿透,手机 SSH 连接本地电脑 |
|
||||||
|
| `工具集.md` | 0.5KB | 开发工具推荐列表 |
|
||||||
|
|
||||||
|
### 🤖 提示词与 AI
|
||||||
|
|
||||||
|
| 文档 | 大小 | 说明 |
|
||||||
|
|------|------|------|
|
||||||
|
| `系统提示词构建原则.md` | 5.6KB | 系统提示词设计指南:沟通互动、任务执行、编码规范、安全防护 |
|
||||||
|
|
||||||
|
### 📚 学习资源
|
||||||
|
|
||||||
|
| 文档 | 大小 | 说明 |
|
||||||
|
|------|------|------|
|
||||||
|
| `编程书籍推荐.md` | 6KB | 编程书籍推荐列表与阅读建议 |
|
||||||
|
|
||||||
|
## 推荐阅读顺序
|
||||||
|
|
||||||
|
**新手入门**:
|
||||||
|
1. `编程之道.md` - 理解编程哲学
|
||||||
|
2. `通用项目架构模板.md` - 学习项目结构
|
||||||
|
3. `开发经验.md` - 掌握编码规范
|
||||||
|
|
||||||
|
**Vibe Coding 实践**:
|
||||||
|
1. `胶水编程.md` / `gluecoding.md` - 理解方法论
|
||||||
|
2. `vibe-coding-经验收集.md` - AI 开发技巧
|
||||||
|
3. `系统提示词构建原则.md` - 提示词设计
|
||||||
|
|
||||||
|
**工具配置**:
|
||||||
|
1. `auggie-mcp配置文档.md` - Augment 引擎
|
||||||
|
2. `tmux快捷键大全.md` - 终端复用
|
||||||
|
3. `关于手机ssh...frp实现的方法.md` - 远程连接
|
||||||
|
|
||||||
|
## 贡献新文档
|
||||||
|
|
||||||
|
1. 使用清晰的中文命名
|
||||||
|
2. 在文件开头说明文档用途
|
||||||
|
3. 更新本 README 的文档列表
|
||||||
|
4. 如有关联,在主 README 中添加链接
|
||||||
|
|
||||||
|
## 相关资源
|
||||||
|
|
||||||
|
- [提示词库](../prompts/) - AI 提示词集合
|
||||||
|
- [技能库](../skills/) - AI Skills 技能
|
||||||
|
- [通用库](../libs/) - 工具与外部集成
|
||||||
|
|
@ -0,0 +1,90 @@
|
||||||
|
# 📦 通用库与外部集成 (Libs)
|
||||||
|
|
||||||
|
`libs/` 目录存放项目的通用库代码和外部集成模块,用于项目内部模块化和工具复用。
|
||||||
|
|
||||||
|
## 目录结构
|
||||||
|
|
||||||
|
```
|
||||||
|
libs/
|
||||||
|
├── README.md # 本文件
|
||||||
|
├── common/ # 通用功能模块
|
||||||
|
│ ├── __init__.py
|
||||||
|
│ ├── models/ # 数据模型定义
|
||||||
|
│ │ └── __init__.py
|
||||||
|
│ └── utils/ # 工具函数
|
||||||
|
│ └── backups/ # 备份工具
|
||||||
|
├── database/ # 数据库相关模块(预留)
|
||||||
|
│ └── .gitkeep
|
||||||
|
└── external/ # 外部集成与第三方工具
|
||||||
|
├── prompts-library/ # 提示词库管理工具
|
||||||
|
├── my-nvim/ # Neovim 配置
|
||||||
|
└── XHS-image-to-PDF-conversion/ # 小红书图片转 PDF
|
||||||
|
```
|
||||||
|
|
||||||
|
## 各子目录详解
|
||||||
|
|
||||||
|
### `common/` - 通用功能模块
|
||||||
|
|
||||||
|
存放项目内部共享的通用代码:
|
||||||
|
|
||||||
|
- `models/` - 数据模型定义,如 Pydantic 模型、数据类等
|
||||||
|
- `utils/` - 工具函数,如文件处理、格式转换等
|
||||||
|
- `utils/backups/` - 备份相关工具函数
|
||||||
|
|
||||||
|
### `database/` - 数据库模块(预留)
|
||||||
|
|
||||||
|
预留的数据库适配层,用于未来扩展数据持久化功能。
|
||||||
|
|
||||||
|
### `external/` - 外部集成
|
||||||
|
|
||||||
|
#### `prompts-library/` - 提示词库管理工具
|
||||||
|
|
||||||
|
Excel ↔ Markdown 提示词互转工具:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd libs/external/prompts-library
|
||||||
|
pip install -r requirements.txt
|
||||||
|
python main.py
|
||||||
|
```
|
||||||
|
|
||||||
|
功能:
|
||||||
|
- Excel 转 Markdown:批量将表格提示词转为 .md 文件
|
||||||
|
- Markdown 转 Excel:将 .md 文件汇总到表格中
|
||||||
|
- 支持分类、标签、版本管理
|
||||||
|
|
||||||
|
#### `my-nvim/` - Neovim 配置
|
||||||
|
|
||||||
|
个人 Neovim 配置,基于 LazyVim,包含:
|
||||||
|
- LSP 配置
|
||||||
|
- 代码补全
|
||||||
|
- 文件导航
|
||||||
|
- Git 集成
|
||||||
|
|
||||||
|
#### `XHS-image-to-PDF-conversion/` - 小红书图片转 PDF
|
||||||
|
|
||||||
|
将小红书图片合并为 PDF 的工具:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd libs/external/XHS-image-to-PDF-conversion
|
||||||
|
pip install -r requirements.txt
|
||||||
|
python pdf.py
|
||||||
|
```
|
||||||
|
|
||||||
|
## 使用原则
|
||||||
|
|
||||||
|
1. **分层边界**: `common/` 只放通用代码,业务逻辑放其他地方
|
||||||
|
2. **单一职责**: 每个模块只做一件事
|
||||||
|
3. **依赖记录**: 新增外部依赖时更新对应的 `requirements.txt`
|
||||||
|
4. **文档同步**: 新增模块时更新本 README
|
||||||
|
|
||||||
|
## 新增模块指南
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 新增通用模块
|
||||||
|
mkdir -p libs/common/新模块名
|
||||||
|
touch libs/common/新模块名/__init__.py
|
||||||
|
|
||||||
|
# 新增外部集成
|
||||||
|
mkdir -p libs/external/工具名
|
||||||
|
echo "# 工具说明" > libs/external/工具名/README.md
|
||||||
|
```
|
||||||
|
|
@ -0,0 +1,27 @@
|
||||||
|
# 🔧 通用功能模块 (Common)
|
||||||
|
|
||||||
|
存放项目内部共享的通用代码,包括数据模型和工具函数。
|
||||||
|
|
||||||
|
## 目录结构
|
||||||
|
|
||||||
|
```
|
||||||
|
common/
|
||||||
|
├── __init__.py
|
||||||
|
├── models/ # 数据模型定义
|
||||||
|
│ └── __init__.py
|
||||||
|
└── utils/ # 工具函数
|
||||||
|
└── backups/ # 备份工具
|
||||||
|
```
|
||||||
|
|
||||||
|
## 子模块
|
||||||
|
|
||||||
|
- `models/` - Pydantic 模型、数据类等
|
||||||
|
- `utils/` - 文件处理、格式转换等工具函数
|
||||||
|
- `utils/backups/` - 备份相关工具
|
||||||
|
|
||||||
|
## 使用
|
||||||
|
|
||||||
|
```python
|
||||||
|
from libs.common.models import YourModel
|
||||||
|
from libs.common.utils import your_function
|
||||||
|
```
|
||||||
|
|
@ -0,0 +1,22 @@
|
||||||
|
# 🗄️ 数据库模块 (Database)
|
||||||
|
|
||||||
|
预留的数据库适配层,用于未来扩展数据持久化功能。
|
||||||
|
|
||||||
|
## 规划用途
|
||||||
|
|
||||||
|
- 数据库连接管理
|
||||||
|
- ORM 模型定义
|
||||||
|
- 数据迁移脚本
|
||||||
|
- 查询工具函数
|
||||||
|
|
||||||
|
## 待实现
|
||||||
|
|
||||||
|
当前为占位目录,后续可添加:
|
||||||
|
|
||||||
|
```
|
||||||
|
database/
|
||||||
|
├── __init__.py
|
||||||
|
├── connection.py # 连接管理
|
||||||
|
├── models.py # ORM 模型
|
||||||
|
└── migrations/ # 迁移脚本
|
||||||
|
```
|
||||||
|
|
@ -0,0 +1,29 @@
|
||||||
|
# 🔌 外部集成模块 (External)
|
||||||
|
|
||||||
|
存放第三方工具、外部依赖和集成模块。
|
||||||
|
|
||||||
|
## 目录结构
|
||||||
|
|
||||||
|
```
|
||||||
|
external/
|
||||||
|
├── prompts-library/ # 提示词库管理工具(Excel ↔ MD 互转)
|
||||||
|
├── my-nvim/ # Neovim 配置
|
||||||
|
└── XHS-image-to-PDF-conversion/ # 小红书图片转 PDF
|
||||||
|
```
|
||||||
|
|
||||||
|
## 工具说明
|
||||||
|
|
||||||
|
| 工具 | 用途 | 使用方法 |
|
||||||
|
|------|------|----------|
|
||||||
|
| `prompts-library` | 提示词 Excel/MD 互转 | `python main.py` |
|
||||||
|
| `my-nvim` | Neovim 配置 | 复制到 `~/.config/nvim` |
|
||||||
|
| `XHS-image-to-PDF-conversion` | 图片合并 PDF | `python pdf.py` |
|
||||||
|
|
||||||
|
## 新增外部工具
|
||||||
|
|
||||||
|
```bash
|
||||||
|
mkdir -p libs/external/工具名
|
||||||
|
echo "# 工具说明" > libs/external/工具名/README.md
|
||||||
|
```
|
||||||
|
|
||||||
|
新增时请注明来源、许可证和依赖。
|
||||||
|
|
@ -1,33 +1,81 @@
|
||||||
# 💡 AI 提示词库 (Prompts Library)
|
# 💡 AI 提示词库 (Prompts Library)
|
||||||
|
|
||||||
`prompts/` 目录是本项目中 AI 提示词的核心资产,包含了大量经过精心设计和分类的提示词,用于指导 AI 进行各种任务,从代码生成到系统行为设定。这些提示词是实现高质量 AI 结对编程的关键。
|
`prompts/` 目录是本项目中 AI 提示词的核心资产,包含 **40+ 个**经过精心设计和分类的提示词,用于指导 AI 进行各种任务。
|
||||||
|
|
||||||
## 目录结构
|
## 目录结构
|
||||||
|
|
||||||
```
|
```
|
||||||
prompts/
|
prompts/
|
||||||
├── coding_prompts/ # 编程与代码生成相关提示词
|
├── README.md # 本文件
|
||||||
├── system_prompts/ # AI 系统级提示词,用于设定 AI 行为和思维框架
|
├── coding_prompts/ # 编程与代码生成相关提示词(40+ 个)
|
||||||
└── user_prompts/ # 用户自定义或常用的提示词
|
│ ├── index.md # 提示词索引与版本矩阵
|
||||||
|
│ ├── plan提示词.md # 实施计划生成
|
||||||
|
│ ├── 系统架构可视化生成Mermaid.md
|
||||||
|
│ ├── 项目上下文文档生成.md
|
||||||
|
│ └── ...
|
||||||
|
├── system_prompts/ # AI 系统级提示词(10 个版本)
|
||||||
|
│ └── CLAUDE.md/
|
||||||
|
│ ├── 1/ ~ 10/ # 不同版本的系统提示词
|
||||||
|
│ └── ...
|
||||||
|
└── user_prompts/ # 用户自定义提示词
|
||||||
|
├── ASCII图生成.md
|
||||||
|
├── 数据管道.md
|
||||||
|
└── 项目变量与工具统一维护.md
|
||||||
```
|
```
|
||||||
|
|
||||||
## 各子目录说明
|
## 各子目录详解
|
||||||
|
|
||||||
### `coding_prompts/`
|
### `coding_prompts/` - 编程提示词集
|
||||||
|
|
||||||
此目录存放专注于编程和代码生成任务的提示词。它们旨在帮助 AI 理解编程需求、生成符合规范的代码、进行代码分析、重构和调试等。这些提示词通常包含了对编程语言、框架、最佳实践和特定代码结构的详细指示。
|
| 类别 | 示例提示词 | 用途 |
|
||||||
|
|------|-----------|------|
|
||||||
|
| 项目规划 | `plan提示词.md` | 生成详细实施计划 |
|
||||||
|
| 架构设计 | `系统架构可视化生成Mermaid.md` | 架构分析与可视化 |
|
||||||
|
| 文档生成 | `项目上下文文档生成.md`、`精华技术文档生成提示词.md` | 自动生成项目文档 |
|
||||||
|
| 代码规范 | `标准项目目录结构.md`、`标准化流程.md` | 统一代码风格与结构 |
|
||||||
|
| 需求分析 | `智能需求理解与研发导航引擎.md` | 需求澄清与任务分解 |
|
||||||
|
| 深度思考 | `ultrathink` 系列 | 触发 AI 深度推理模式 |
|
||||||
|
|
||||||
### `system_prompts/`
|
**索引文件**: `index.md` 提供完整的提示词列表和快速跳转链接。
|
||||||
|
|
||||||
此目录包含用于设定 AI 整体行为模式、思维框架和角色定位的系统级提示词。通过这些提示词,可以定义 AI 的个性、它与用户交互的方式、以及在解决问题时应遵循的原则。它们是确保 AI 能够以稳定、一致且符合预期的行为进行工作的基础。
|
### `system_prompts/` - 系统级提示词
|
||||||
|
|
||||||
### `user_prompts/`
|
用于设定 AI 整体行为模式和思维框架,当前包含 **10 个版本**:
|
||||||
|
|
||||||
此目录用于存放用户自定义或常用的提示词。这些提示词可以是个性化的任务指令、常用的查询模板或特定项目的工作流指南。用户可以根据自己的需求在此处添加和管理自己的提示词,以便于快速调用和复用。
|
| 版本 | 特点 |
|
||||||
|
|------|------|
|
||||||
|
| v1 | 开发者行为准则与工程规范 |
|
||||||
|
| v2 | ultrathink 模式与架构可视化规范 |
|
||||||
|
| v3 | 思维创作哲学与执行确认机制 |
|
||||||
|
| v4 | Linus 级工程师服务认知架构 |
|
||||||
|
| v5 | 顶级程序员思维框架与代码品味 |
|
||||||
|
| v6 | 综合版本,整合所有最佳实践 |
|
||||||
|
| v7 | 推理与规划智能体,专职复杂任务分解 |
|
||||||
|
| v8 | 最新综合版,顶级程序员服务 Linus 级工程师 |
|
||||||
|
| v9 | 简化版本(实验性) |
|
||||||
|
| v10 | 最新版,加入 Augment 上下文引擎规范 |
|
||||||
|
|
||||||
## 提示词的使用与管理
|
**推荐**: 新项目建议从 `v8` 或 `v10` 开始。
|
||||||
|
|
||||||
* **分类明确:** 提示词根据其用途被清晰地分类到不同的子目录中,方便查找和管理。
|
### `user_prompts/` - 用户自定义提示词
|
||||||
* **内容丰富:** 每个提示词都经过精心设计,以提供足够的信息和指导,确保 AI 能够准确理解任务。
|
|
||||||
* **持续优化:** 提示词是一个动态的知识库,可以根据实际使用效果和 AI 模型的演进进行持续的优化和更新。
|
- `ASCII图生成.md` - 生成 ASCII 艺术图
|
||||||
* **结合工具:** 提示词可与 `libs/external/prompts-library` 中的提示词管理工具结合使用,进行 Excel 与 Markdown 格式的相互转换,实现更便捷的编辑和维护。
|
- `数据管道.md` - 数据处理流程设计
|
||||||
|
- `项目变量与工具统一维护.md` - 项目配置管理
|
||||||
|
|
||||||
|
## 快速使用
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 查看某个提示词
|
||||||
|
cat prompts/coding_prompts/plan提示词.md
|
||||||
|
|
||||||
|
# 使用 v8 版本的系统提示词
|
||||||
|
cp prompts/system_prompts/CLAUDE.md/8/CLAUDE.md ./CLAUDE.md
|
||||||
|
```
|
||||||
|
|
||||||
|
## 相关资源
|
||||||
|
|
||||||
|
- [Google 表格提示词数据库](https://docs.google.com/spreadsheets/d/1ngoQOhJqdguwNAilCl1joNwTje7FWWN9WiI2bo5VhpU/edit?gid=2093180351#gid=2093180351&range=A1)
|
||||||
|
- [元提示词](https://docs.google.com/spreadsheets/d/1ngoQOhJqdguwNAilCl1joNwTje7FWWN9WiI2bo5VhpU/edit?gid=1770874220#gid=1770874220)
|
||||||
|
- [系统提示词收集仓库](https://github.com/x1xhlol/system-prompts-and-models-of-ai-tools)
|
||||||
|
- [Skills 生成器](https://github.com/yusufkaraaslan/Skill_Seekers)
|
||||||
|
|
|
||||||
253
skills/README.md
253
skills/README.md
|
|
@ -1,40 +1,241 @@
|
||||||
# 🤖 AI 技能库 (Skills Library)
|
# 🎯 AI Skills 技能库
|
||||||
|
|
||||||
`skills/` 目录是本项目中 AI 技能的模块化集合。每个子目录代表一个独立的技能模块,旨在为 AI 提供特定的工具、领域知识和操作能力。这些技能使得 AI 能够执行更复杂、更专业的任务。
|
`skills/` 目录存放 AI 技能(Skills),这些是比提示词更高级的能力封装,可以让 AI 在特定领域表现出专家级水平。当前包含 **14 个**专业技能。
|
||||||
|
|
||||||
## 目录结构
|
## 目录结构
|
||||||
|
|
||||||
```
|
```
|
||||||
skills/
|
skills/
|
||||||
├───ccxt/ # CCXT 加密货币交易库技能
|
├── README.md # 本文件
|
||||||
├───claude-code-guide/ # Claude Code 使用指南技能
|
│
|
||||||
├───claude-cookbooks/ # Claude Cookbooks 技能
|
├── # === 元技能(核心) ===
|
||||||
├───claude-skills/ # Claude 核心技能
|
├── claude-skills/ # ⭐ 元技能:生成 Skills 的 Skills(11KB)
|
||||||
├───coingecko/ # CoinGecko 数据查询技能
|
│
|
||||||
├───cryptofeed/ # CryptoFeed 实时数据处理技能
|
├── # === Claude 工具 ===
|
||||||
├───hummingbot/ # Hummingbot 量化交易机器人技能
|
├── claude-code-guide/ # Claude Code 使用指南(9KB)
|
||||||
├───polymarket/ # Polymarket 预测市场技能
|
├── claude-cookbooks/ # Claude API 最佳实践(9KB)
|
||||||
├───postgresql/ # PostgreSQL 数据库操作技能
|
│
|
||||||
├───proxychains/ # ProxyChains 代理工具技能
|
├── # === 数据库 ===
|
||||||
├───snapdom/ # SnapDOM 网页自动化技能
|
├── postgresql/ # ⭐ PostgreSQL 专家技能(76KB,最详细)
|
||||||
├───telegram-dev/ # Telegram Bot 开发技能
|
├── timescaledb/ # 时序数据库扩展(3KB)
|
||||||
├───timescaledb/ # TimescaleDB 时序数据库技能
|
│
|
||||||
└───twscrape/ # Twscrape 数据抓取技能
|
├── # === 加密货币/量化 ===
|
||||||
|
├── ccxt/ # 加密货币交易所统一 API(18KB)
|
||||||
|
├── coingecko/ # CoinGecko 行情 API(3KB)
|
||||||
|
├── cryptofeed/ # 加密货币实时数据流(6KB)
|
||||||
|
├── hummingbot/ # 量化交易机器人框架(4KB)
|
||||||
|
├── polymarket/ # 预测市场 API(6KB)
|
||||||
|
│
|
||||||
|
├── # === 开发工具 ===
|
||||||
|
├── telegram-dev/ # Telegram Bot 开发(18KB)
|
||||||
|
├── twscrape/ # Twitter/X 数据抓取(11KB)
|
||||||
|
├── snapdom/ # DOM 快照工具(8KB)
|
||||||
|
└── proxychains/ # 代理链配置(6KB)
|
||||||
```
|
```
|
||||||
|
|
||||||
## 各技能模块说明
|
## Skills 一览表
|
||||||
|
|
||||||
每个技能模块通常包含以下内容:
|
### 按文件大小排序(详细程度)
|
||||||
|
|
||||||
* **`SKILL.md`**: 该技能的详细描述、功能、使用场景和限制。
|
| 技能 | 大小 | 领域 | 说明 |
|
||||||
* **`assets/`**: 与该技能相关的图像、图表或其他非代码资产。
|
|------|------|------|------|
|
||||||
* **`references/`**: 相关文档、API 文档链接、教程或其他参考资料。
|
| **postgresql** | 76KB | 数据库 | ⭐ 最详细,PostgreSQL 完整专家技能 |
|
||||||
* **`scripts/`**: 实现该技能的具体脚本或代码示例。
|
| **telegram-dev** | 18KB | Bot 开发 | Telegram Bot 开发完整指南 |
|
||||||
|
| **ccxt** | 18KB | 交易 | 加密货币交易所统一 API |
|
||||||
|
| **twscrape** | 11KB | 数据采集 | Twitter/X 数据抓取 |
|
||||||
|
| **claude-skills** | 11KB | 元技能 | ⭐ 生成 Skills 的 Skills |
|
||||||
|
| **claude-code-guide** | 9KB | 工具 | Claude Code 使用最佳实践 |
|
||||||
|
| **claude-cookbooks** | 9KB | 工具 | Claude API 使用示例 |
|
||||||
|
| **snapdom** | 8KB | 前端 | DOM 快照与测试 |
|
||||||
|
| **cryptofeed** | 6KB | 数据流 | 加密货币实时数据流 |
|
||||||
|
| **polymarket** | 6KB | 预测市场 | Polymarket API 集成 |
|
||||||
|
| **proxychains** | 6KB | 网络 | 代理链配置与使用 |
|
||||||
|
| **hummingbot** | 4KB | 量化 | 量化交易机器人框架 |
|
||||||
|
| **timescaledb** | 3KB | 数据库 | PostgreSQL 时序扩展 |
|
||||||
|
| **coingecko** | 3KB | 行情 | CoinGecko 行情 API |
|
||||||
|
|
||||||
## 如何使用技能
|
### 按领域分类
|
||||||
|
|
||||||
AI Agent 在执行任务时,会根据任务需求调用相应的技能模块。开发者可以通过阅读每个技能模块内的 `SKILL.md` 文件,了解其具体功能和如何集成到 AI 的工作流程中。
|
#### 🔧 元技能与工具
|
||||||
|
|
||||||
## 扩展与贡献
|
| 技能 | 说明 | 推荐场景 |
|
||||||
|
|------|------|----------|
|
||||||
|
| `claude-skills` | 生成 Skills 的 Skills | 创建新技能时必用 |
|
||||||
|
| `claude-code-guide` | Claude Code CLI 使用指南 | 日常开发 |
|
||||||
|
| `claude-cookbooks` | Claude API 最佳实践 | API 集成 |
|
||||||
|
|
||||||
本项目鼓励为 AI 技能库贡献新的技能模块。如果你有新的工具或领域知识希望集成到 AI 的能力中,可以创建一个新的子目录,并按照上述结构填充 `SKILL.md`、`assets/`、`references/` 和 `scripts/`。这有助于持续增强 AI 的能力和应用范围。
|
#### 🗄️ 数据库
|
||||||
|
|
||||||
|
| 技能 | 说明 | 推荐场景 |
|
||||||
|
|------|------|----------|
|
||||||
|
| `postgresql` | PostgreSQL 完整指南(76KB) | 关系型数据库开发 |
|
||||||
|
| `timescaledb` | 时序数据库扩展 | 时间序列数据 |
|
||||||
|
|
||||||
|
#### 💰 加密货币/量化
|
||||||
|
|
||||||
|
| 技能 | 说明 | 推荐场景 |
|
||||||
|
|------|------|----------|
|
||||||
|
| `ccxt` | 交易所统一 API | 多交易所对接 |
|
||||||
|
| `coingecko` | 行情数据 API | 价格查询 |
|
||||||
|
| `cryptofeed` | 实时数据流 | WebSocket 行情 |
|
||||||
|
| `hummingbot` | 量化交易框架 | 自动化交易 |
|
||||||
|
| `polymarket` | 预测市场 API | 预测市场交易 |
|
||||||
|
|
||||||
|
#### 🛠️ 开发工具
|
||||||
|
|
||||||
|
| 技能 | 说明 | 推荐场景 |
|
||||||
|
|------|------|----------|
|
||||||
|
| `telegram-dev` | Telegram Bot 开发 | Bot 开发 |
|
||||||
|
| `twscrape` | Twitter 数据抓取 | 社交媒体数据 |
|
||||||
|
| `snapdom` | DOM 快照 | 前端测试 |
|
||||||
|
| `proxychains` | 代理链配置 | 网络代理 |
|
||||||
|
|
||||||
|
## Skills vs Prompts 的区别
|
||||||
|
|
||||||
|
| 维度 | Prompts(提示词) | Skills(技能) |
|
||||||
|
|------|------------------|----------------|
|
||||||
|
| 粒度 | 单次任务指令 | 完整能力封装 |
|
||||||
|
| 复用性 | 复制粘贴 | 配置后自动生效 |
|
||||||
|
| 上下文 | 需手动提供 | 内置领域知识 |
|
||||||
|
| 适用场景 | 临时任务 | 长期项目 |
|
||||||
|
| 结构 | 单文件 | 目录(含 assets/scripts/references) |
|
||||||
|
|
||||||
|
## 技能目录结构
|
||||||
|
|
||||||
|
每个技能遵循统一结构:
|
||||||
|
|
||||||
|
```
|
||||||
|
skill-name/
|
||||||
|
├── SKILL.md # 技能主文件,包含领域知识和规则
|
||||||
|
├── assets/ # 静态资源(图片、配置模板等)
|
||||||
|
├── scripts/ # 辅助脚本
|
||||||
|
└── references/ # 参考文档
|
||||||
|
```
|
||||||
|
|
||||||
|
## 快速使用
|
||||||
|
|
||||||
|
### 1. 查看技能
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 查看元技能
|
||||||
|
cat skills/claude-skills/SKILL.md
|
||||||
|
|
||||||
|
# 查看 PostgreSQL 技能(最详细)
|
||||||
|
cat skills/postgresql/SKILL.md
|
||||||
|
|
||||||
|
# 查看 Telegram Bot 开发技能
|
||||||
|
cat skills/telegram-dev/SKILL.md
|
||||||
|
```
|
||||||
|
|
||||||
|
### 2. 复制到项目中使用
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 复制整个技能目录
|
||||||
|
cp -r skills/postgresql/ ./my-project/
|
||||||
|
|
||||||
|
# 或只复制主文件到 CLAUDE.md
|
||||||
|
cp skills/postgresql/SKILL.md ./CLAUDE.md
|
||||||
|
```
|
||||||
|
|
||||||
|
### 3. 结合 Claude Code 使用
|
||||||
|
|
||||||
|
在项目根目录创建 `CLAUDE.md`,引用技能:
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
# 项目规则
|
||||||
|
|
||||||
|
请参考以下技能文件:
|
||||||
|
@skills/postgresql/SKILL.md
|
||||||
|
@skills/telegram-dev/SKILL.md
|
||||||
|
```
|
||||||
|
|
||||||
|
## 创建自定义 Skill
|
||||||
|
|
||||||
|
### 方法一:使用元技能生成(推荐)
|
||||||
|
|
||||||
|
1. 准备领域资料(文档、代码、规范)
|
||||||
|
2. 将资料和 `skills/claude-skills/SKILL.md` 一起提供给 AI
|
||||||
|
3. AI 会生成针对该领域的专用 Skill
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 示例:让 AI 读取元技能后生成新技能
|
||||||
|
cat skills/claude-skills/SKILL.md
|
||||||
|
# 然后告诉 AI:请根据这个元技能,为 [你的领域] 生成一个新的 SKILL.md
|
||||||
|
```
|
||||||
|
|
||||||
|
### 方法二:手动创建
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 创建技能目录
|
||||||
|
mkdir -p skills/my-skill/{assets,scripts,references}
|
||||||
|
|
||||||
|
# 创建主文件
|
||||||
|
cat > skills/my-skill/SKILL.md << 'EOF'
|
||||||
|
# My Skill
|
||||||
|
|
||||||
|
## 概述
|
||||||
|
简要说明技能用途和适用场景
|
||||||
|
|
||||||
|
## 领域知识
|
||||||
|
- 核心概念
|
||||||
|
- 最佳实践
|
||||||
|
- 常见模式
|
||||||
|
|
||||||
|
## 规则与约束
|
||||||
|
- 必须遵守的规则
|
||||||
|
- 禁止的操作
|
||||||
|
- 边界条件
|
||||||
|
|
||||||
|
## 示例
|
||||||
|
具体的使用示例和代码片段
|
||||||
|
|
||||||
|
## 常见问题
|
||||||
|
FAQ 和解决方案
|
||||||
|
EOF
|
||||||
|
```
|
||||||
|
|
||||||
|
## 核心技能详解
|
||||||
|
|
||||||
|
### `claude-skills/SKILL.md` - 元技能 ⭐
|
||||||
|
|
||||||
|
**生成 Skills 的 Skills**,是创建新技能的核心工具。
|
||||||
|
|
||||||
|
使用方法:
|
||||||
|
1. 准备你的领域资料(文档、代码、规范等)
|
||||||
|
2. 将资料和 SKILL.md 一起提供给 AI
|
||||||
|
3. AI 会生成针对该领域的专用 Skill
|
||||||
|
|
||||||
|
### `postgresql/SKILL.md` - PostgreSQL 专家 ⭐
|
||||||
|
|
||||||
|
最详细的技能(76KB),包含:
|
||||||
|
- 数据库设计最佳实践
|
||||||
|
- 查询优化技巧
|
||||||
|
- 索引策略
|
||||||
|
- 性能调优
|
||||||
|
- 常见问题解决方案
|
||||||
|
- SQL 代码示例
|
||||||
|
|
||||||
|
### `telegram-dev/SKILL.md` - Telegram Bot 开发
|
||||||
|
|
||||||
|
完整的 Telegram Bot 开发指南(18KB):
|
||||||
|
- Bot API 使用
|
||||||
|
- 消息处理
|
||||||
|
- 键盘与回调
|
||||||
|
- Webhook 配置
|
||||||
|
- 错误处理
|
||||||
|
|
||||||
|
### `ccxt/SKILL.md` - 加密货币交易所 API
|
||||||
|
|
||||||
|
统一的交易所 API 封装(18KB):
|
||||||
|
- 支持 100+ 交易所
|
||||||
|
- 统一的数据格式
|
||||||
|
- 订单管理
|
||||||
|
- 行情获取
|
||||||
|
|
||||||
|
## 相关资源
|
||||||
|
|
||||||
|
- [Skills 生成器](https://github.com/yusufkaraaslan/Skill_Seekers) - 把任何资料转为 AI Skills
|
||||||
|
- [元技能文件](./claude-skills/SKILL.md) - 生成 Skills 的 Skills
|
||||||
|
- [提示词库](../prompts/) - 更细粒度的提示词集合
|
||||||
|
- [Claude Code 指南](./claude-code-guide/SKILL.md) - Claude Code 使用最佳实践
|
||||||
|
- [文档库](../documents/) - 方法论与开发经验
|
||||||
|
|
|
||||||
Binary file not shown.
|
|
@ -0,0 +1,78 @@
|
||||||
|
---
|
||||||
|
name: my-skill
|
||||||
|
description: Full description of what this skill does, when to use it, and its core capabilities
|
||||||
|
---
|
||||||
|
|
||||||
|
# Skill Name
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
Brief explanation of the skill's purpose and value.
|
||||||
|
|
||||||
|
## When to Use This Skill
|
||||||
|
|
||||||
|
- Scenario 1: [description]
|
||||||
|
- Scenario 2: [description]
|
||||||
|
- Scenario 3: [description]
|
||||||
|
|
||||||
|
## Instructions
|
||||||
|
|
||||||
|
### Step 1: [Step Name]
|
||||||
|
|
||||||
|
[Detailed explanation]
|
||||||
|
|
||||||
|
### Step 2: [Step Name]
|
||||||
|
|
||||||
|
[Detailed explanation]
|
||||||
|
|
||||||
|
### Step 3: [Step Name]
|
||||||
|
|
||||||
|
[Detailed explanation]
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
### Example 1: [Scenario Name]
|
||||||
|
|
||||||
|
**Input:**
|
||||||
|
|
||||||
|
```
|
||||||
|
[input content]
|
||||||
|
```
|
||||||
|
|
||||||
|
**Output:**
|
||||||
|
|
||||||
|
```
|
||||||
|
[output content]
|
||||||
|
```
|
||||||
|
|
||||||
|
### Example 2: [Scenario Name]
|
||||||
|
|
||||||
|
**Input:**
|
||||||
|
|
||||||
|
```
|
||||||
|
[input content]
|
||||||
|
```
|
||||||
|
|
||||||
|
**Output:**
|
||||||
|
|
||||||
|
```
|
||||||
|
[output content]
|
||||||
|
```
|
||||||
|
|
||||||
|
## Constraints
|
||||||
|
|
||||||
|
- Limitation 1: [description]
|
||||||
|
- Limitation 2: [description]
|
||||||
|
- Limitation 3: [description]
|
||||||
|
|
||||||
|
## Error Handling
|
||||||
|
|
||||||
|
| Error | Cause | Solution |
|
||||||
|
|-------|-------|----------|
|
||||||
|
| Error 1 | [cause] | [solution] |
|
||||||
|
| Error 2 | [cause] | [solution] |
|
||||||
|
|
||||||
|
## Resources
|
||||||
|
|
||||||
|
- [Resource 1](link)
|
||||||
|
- [Resource 2](link)
|
||||||
|
|
@ -0,0 +1,14 @@
|
||||||
|
---
|
||||||
|
name: my-skill
|
||||||
|
description: Brief description of what this skill does and when to use it
|
||||||
|
---
|
||||||
|
|
||||||
|
# Skill Name
|
||||||
|
|
||||||
|
## Instructions
|
||||||
|
|
||||||
|
[Core instructions here]
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
[Usage examples here]
|
||||||
|
|
@ -0,0 +1,54 @@
|
||||||
|
#!/bin/bash
|
||||||
|
# Quick Skill directory structure generator
|
||||||
|
# Usage: ./create-skill.sh <skill-name>
|
||||||
|
|
||||||
|
SKILL_NAME=$1
|
||||||
|
|
||||||
|
if [ -z "$SKILL_NAME" ]; then
|
||||||
|
echo "Usage: ./create-skill.sh <skill-name>"
|
||||||
|
echo "Example: ./create-skill.sh my-awesome-skill"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
mkdir -p "$SKILL_NAME"/{assets,scripts,references}
|
||||||
|
|
||||||
|
cat > "$SKILL_NAME/SKILL.md" << 'EOF'
|
||||||
|
---
|
||||||
|
name: SKILL_NAME_PLACEHOLDER
|
||||||
|
description: Skill description
|
||||||
|
---
|
||||||
|
|
||||||
|
# Skill Name
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
Brief explanation of the skill's purpose.
|
||||||
|
|
||||||
|
## When to Use This Skill
|
||||||
|
|
||||||
|
- Scenario 1
|
||||||
|
- Scenario 2
|
||||||
|
|
||||||
|
## Instructions
|
||||||
|
|
||||||
|
[Detailed instructions]
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
[Usage examples]
|
||||||
|
|
||||||
|
## Constraints
|
||||||
|
|
||||||
|
- Limitation 1
|
||||||
|
- Limitation 2
|
||||||
|
EOF
|
||||||
|
|
||||||
|
sed -i "s/SKILL_NAME_PLACEHOLDER/$SKILL_NAME/g" "$SKILL_NAME/SKILL.md"
|
||||||
|
|
||||||
|
echo "✅ Created Skill: $SKILL_NAME/"
|
||||||
|
echo " ├── SKILL.md"
|
||||||
|
echo " ├── assets/"
|
||||||
|
echo " ├── scripts/"
|
||||||
|
echo " └── references/"
|
||||||
|
echo ""
|
||||||
|
echo "Next: Edit $SKILL_NAME/SKILL.md to add your instructions"
|
||||||
Loading…
Reference in New Issue