mirror of
https://github.com/zhangyanxs/repo2skill.git
synced 2026-11-18 18:03:50 +00:00
feat: ✨ Add local repository support with intelligent input detection
- Add Step 0: Input Detection to automatically distinguish between remote URLs and local paths - Add Step 3B: Local Repository Extraction for direct filesystem analysis - Add is_local_path() and parse_local_info() helper functions in utils.sh - Update IMPLEMENTATION.md with local repository flow documentation - Update README.md and README_ZH.md with local usage examples - Support relative (./), absolute (/), and home (~) directory paths - Local analysis is 2-3x faster than remote (no network overhead)
This commit is contained in:
@@ -21,6 +21,7 @@ You found an amazing open-source project and want AI to help you understand and
|
||||
|
||||
- **🤖 AI-Powered Analysis**: Uses your configured LLM in OpenCode/Claude Code to analyze repositories intelligently
|
||||
- **🌐 Multi-Platform Support**: Supports GitHub, GitLab, and Gitee - one tool for all
|
||||
- **📁 Local Repository Support**: Direct analysis of local project directories - no network required
|
||||
- **⚡ Intelligent Mirror Rotation**: Built-in 10+ GitHub mirrors with automatic failover and rate limit handling
|
||||
- **📦 Zero Dependencies**: No npm install, no API keys, no external packages - works out of the box
|
||||
- **🔄 Batch Conversion**: Convert multiple repositories simultaneously with parallel processing
|
||||
@@ -60,9 +61,17 @@ Start OpenCode or Claude Code and say:
|
||||
帮我把这个仓库转成技能:https://github.com/vercel/next.js
|
||||
```
|
||||
|
||||
OR for local projects:
|
||||
|
||||
```
|
||||
帮我把当前项目转成技能
|
||||
|
||||
帮我把这个本地项目转成技能:./my-project
|
||||
```
|
||||
|
||||
**The skill will automatically:**
|
||||
1. ✅ Parse repository URL and detect platform
|
||||
2. 🔍 Fetch data from multiple mirror endpoints
|
||||
1. ✅ Detect input type (remote URL or local path)
|
||||
2. 🔍 Fetch/Extract data (from mirrors or local filesystem)
|
||||
3. 📖 Use your configured LLM to analyze the repository
|
||||
4. 📝 Generate a complete SKILL.md with 18+ sections
|
||||
5. 💾 Ask you where to save the generated skill
|
||||
@@ -125,6 +134,29 @@ Start OpenCode or Claude Code and say:
|
||||
帮我把这个 Gitee 仓库转成技能:https://gitee.com/mindspore/docs
|
||||
```
|
||||
|
||||
### Local Repository ✅
|
||||
|
||||
**Supported Paths:**
|
||||
- `./my-project` (relative path)
|
||||
- `/home/user/projects/app` (absolute path)
|
||||
- `~/workspace/project` (home directory)
|
||||
- `my-project` (if directory exists in current path)
|
||||
|
||||
**Features:**
|
||||
- Direct filesystem access - no network required
|
||||
- 2-3x faster than remote repositories
|
||||
- Automatic project type detection (JS, Python, Rust, Go, etc.)
|
||||
- Smart metadata inference from config files
|
||||
- Git remote URL detection (if git repository)
|
||||
|
||||
**Example:**
|
||||
```
|
||||
帮我把当前项目转成技能
|
||||
|
||||
帮我把这个本地项目转成技能:./my-frontend-app
|
||||
帮我把这个目录转成技能:/home/user/projects/my-api-server
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🛠️ How It Works
|
||||
@@ -132,32 +164,42 @@ Start OpenCode or Claude Code and say:
|
||||
### Architecture Overview
|
||||
|
||||
```
|
||||
Repository URL
|
||||
User Input (URL or Local Path)
|
||||
↓
|
||||
1. Parse Platform (GitHub/GitLab/Gitee)
|
||||
1. Input Detection
|
||||
├─ Remote URL (github/gitlab/gitee.com) → Remote Flow
|
||||
└─ Local Path (./, /, ~, or directory) → Local Flow
|
||||
↓
|
||||
2. Mirror Rotation API Calls
|
||||
- Metadata (stars, forks, language)
|
||||
- README content
|
||||
- File tree structure
|
||||
- Key documentation files
|
||||
2a. Remote Repository Flow:
|
||||
- Parse Platform (GitHub/GitLab/Gitee)
|
||||
- Mirror Rotation API Calls
|
||||
· Metadata (stars, forks, language)
|
||||
· README content
|
||||
· File tree structure
|
||||
· Key documentation files
|
||||
↓
|
||||
2b. Local Repository Flow:
|
||||
- Path Validation
|
||||
- File Extraction (README, configs, docs)
|
||||
- Metadata Inference (language, type, deps)
|
||||
- Git Remote Detection (if applicable)
|
||||
↓
|
||||
3. AI Analysis (Your Configured LLM)
|
||||
- Project overview and features
|
||||
- Installation guides
|
||||
- Usage examples
|
||||
- API reference
|
||||
- Troubleshooting
|
||||
- Project overview and features
|
||||
- Installation guides
|
||||
- Usage examples
|
||||
- API reference
|
||||
- Troubleshooting
|
||||
↓
|
||||
4. Generate SKILL.md
|
||||
- YAML frontmatter
|
||||
- 18+ comprehensive sections
|
||||
- Real-world examples
|
||||
- YAML frontmatter
|
||||
- 18+ comprehensive sections
|
||||
- Real-world examples
|
||||
↓
|
||||
5. Save to User-Selected Location
|
||||
- Project local
|
||||
- Global user config
|
||||
- Claude-compatible
|
||||
- Project local
|
||||
- Global user config
|
||||
- Claude-compatible
|
||||
↓
|
||||
✅ Ready to Use!
|
||||
```
|
||||
@@ -242,6 +284,36 @@ Focused documentation (~200-300 lines) with:
|
||||
**Output:**
|
||||
Bilingual skill preserving Chinese documentation with English translations.
|
||||
|
||||
### Example 5: Local Project (New!)
|
||||
|
||||
**Input:**
|
||||
```
|
||||
帮我把当前项目转成技能
|
||||
```
|
||||
|
||||
**Output:**
|
||||
Comprehensive local project skill analyzing your current directory:
|
||||
- Automatic project type detection
|
||||
- Installation and development setup
|
||||
- Local build and test commands
|
||||
- Project-specific architecture documentation
|
||||
- **Time**: 10-30s (faster than remote!)
|
||||
- **No network required**
|
||||
|
||||
**Input:**
|
||||
```
|
||||
帮我把这个本地项目转成技能:./my-frontend-app
|
||||
```
|
||||
|
||||
**Output:**
|
||||
Complete frontend framework documentation including:
|
||||
- Component structure and patterns
|
||||
- State management setup
|
||||
- Routing and navigation
|
||||
- API integration patterns
|
||||
- Build and deployment commands
|
||||
- Local development workflow
|
||||
|
||||
---
|
||||
|
||||
## 📁 Project Structure
|
||||
@@ -249,14 +321,14 @@ Bilingual skill preserving Chinese documentation with English translations.
|
||||
```
|
||||
repo2skill/
|
||||
├── repo2skill/ # 🎯 Main Skill Directory (copy this to use)
|
||||
│ ├── SKILL.md # Core system instructions (397 lines)
|
||||
│ ├── IMPLEMENTATION.md # Technical documentation (165 lines)
|
||||
│ ├── SKILL.md # Core system instructions (~596 lines, with local support)
|
||||
│ ├── IMPLEMENTATION.md # Technical documentation (~240 lines)
|
||||
│ ├── references/ # API reference documentation
|
||||
│ │ ├── github-api.md # GitHub API quick reference (123 lines)
|
||||
│ │ ├── gitlab-api.md # GitLab API quick reference (114 lines)
|
||||
│ │ └── gitee-api.md # Gitee API quick reference (31 lines)
|
||||
│ └── scripts/ # Utility scripts
|
||||
│ └── utils.sh # Bash helper functions (95 lines)
|
||||
│ └── utils.sh # Bash helper functions (~160 lines, with local support)
|
||||
├── README.md # This file
|
||||
├── README_EN.md # English version
|
||||
├── README_ZH.md # Chinese version
|
||||
|
||||
+101
-29
@@ -21,6 +21,7 @@
|
||||
|
||||
- **🤖 AI 智能分析**: 使用你在 OpenCode/Claude Code 中配置的 LLM 智能分析仓库
|
||||
- **🌐 多平台支持**: 支持 GitHub、GitLab 和 Gitee - 一个工具搞定所有平台
|
||||
- **📁 本地仓库支持**: 直接分析本地项目目录 - 无需网络连接
|
||||
- **⚡ 智能镜像轮换**: 内置 10+ 个 GitHub 镜像端点,自动故障转移和速率限制处理
|
||||
- **📦 零依赖**: 无需 npm install,无需 API keys,无需外部包 - 开箱即用
|
||||
- **🔄 批量转换**: 同时转换多个仓库,并行处理
|
||||
@@ -60,9 +61,17 @@ cp -r repo2skill your-project/.opencode/skills/
|
||||
帮我把这个仓库转成技能:https://github.com/vercel/next.js
|
||||
```
|
||||
|
||||
或者用于本地项目:
|
||||
|
||||
```
|
||||
帮我把当前项目转成技能
|
||||
|
||||
帮我把这个本地项目转成技能:./my-project
|
||||
```
|
||||
|
||||
**技能会自动:**
|
||||
1. ✅ 解析仓库 URL 并检测平台
|
||||
2. 🔍 从多个镜像端点获取数据
|
||||
1. ✅ 检测输入类型(远程 URL 或本地路径)
|
||||
2. 🔍 获取/提取数据(从镜像或本地文件系统)
|
||||
3. 📖 使用你配置的 LLM 分析仓库
|
||||
4. 📝 生成包含 18+ 章节的完整 SKILL.md
|
||||
5. 💾 询问你想把生成的技能保存到哪里
|
||||
@@ -125,6 +134,29 @@ cp -r repo2skill your-project/.opencode/skills/
|
||||
帮我把这个 Gitee 仓库转成技能:https://gitee.com/mindspore/docs
|
||||
```
|
||||
|
||||
### 本地仓库 ✅
|
||||
|
||||
**支持的路径:**
|
||||
- `./my-project` (相对路径)
|
||||
- `/home/user/projects/app` (绝对路径)
|
||||
- `~/workspace/project` (家目录)
|
||||
- `my-project` (当前路径下存在的目录)
|
||||
|
||||
**特性:**
|
||||
- 直接文件系统访问 - 无需网络
|
||||
- 比远程仓库快 2-3 倍
|
||||
- 自动项目类型检测(JS、Python、Rust、Go 等)
|
||||
- 从配置文件智能推断元数据
|
||||
- Git 远程 URL 检测(如果是 git 仓库)
|
||||
|
||||
**示例:**
|
||||
```
|
||||
帮我把当前项目转成技能
|
||||
|
||||
帮我把这个本地项目转成技能:./my-frontend-app
|
||||
帮我把这个目录转成技能:/home/user/projects/my-api-server
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🛠️ 工作原理
|
||||
@@ -132,33 +164,43 @@ cp -r repo2skill your-project/.opencode/skills/
|
||||
### 架构概览
|
||||
|
||||
```
|
||||
仓库 URL
|
||||
↓
|
||||
1. 解析平台(GitHub/GitLab/Gitee)
|
||||
↓
|
||||
2. 镜像轮换 API 调用
|
||||
- 元数据(stars, forks, 语言)
|
||||
- README 内容
|
||||
- 文件树结构
|
||||
- 关键文档文件
|
||||
↓
|
||||
用户输入(URL 或本地路径)
|
||||
↓
|
||||
1. 输入检测
|
||||
├─ 远程 URL (github/gitlab/gitee.com) → 远程流程
|
||||
└─ 本地路径 (./, /, ~, 或目录) → 本地流程
|
||||
↓
|
||||
2a. 远程仓库流程:
|
||||
- 解析平台(GitHub/GitLab/Gitee)
|
||||
- 镜像轮换 API 调用
|
||||
· 元数据(stars, forks, 语言)
|
||||
· README 内容
|
||||
· 文件树结构
|
||||
· 关键文档文件
|
||||
↓
|
||||
2b. 本地仓库流程:
|
||||
- 路径验证
|
||||
- 文件提取(README, 配置, 文档)
|
||||
- 元数据推断(语言, 类型, 依赖)
|
||||
- Git 远程检测(如果适用)
|
||||
↓
|
||||
3. AI 分析(你配置的 LLM)
|
||||
- 项目概览和特性
|
||||
- 安装指南
|
||||
- 使用示例
|
||||
- API 参考
|
||||
- 故障排除
|
||||
↓
|
||||
- 项目概览和特性
|
||||
- 安装指南
|
||||
- 使用示例
|
||||
- API 参考
|
||||
- 故障排除
|
||||
↓
|
||||
4. 生成 SKILL.md
|
||||
- YAML frontmatter
|
||||
- 18+ 全面章节
|
||||
- 真实示例
|
||||
↓
|
||||
- YAML frontmatter
|
||||
- 18+ 全面章节
|
||||
- 真实示例
|
||||
↓
|
||||
5. 保存到用户选择的位置
|
||||
- 项目本地
|
||||
- 全局用户配置
|
||||
- Claude 兼容
|
||||
↓
|
||||
- 项目本地
|
||||
- 全局用户配置
|
||||
- Claude 兼容
|
||||
↓
|
||||
✅ 准备使用!
|
||||
```
|
||||
|
||||
@@ -242,6 +284,36 @@ cp -r repo2skill your-project/.opencode/skills/
|
||||
**输出:**
|
||||
双语技能,保留中文文档并提供英文翻译。
|
||||
|
||||
### 示例 5: 本地项目(新增!)
|
||||
|
||||
**输入:**
|
||||
```
|
||||
帮我把当前项目转成技能
|
||||
```
|
||||
|
||||
**输出:**
|
||||
全面的本地项目技能,分析当前目录:
|
||||
- 自动项目类型检测
|
||||
- 安装和开发设置
|
||||
- 本地构建和测试命令
|
||||
- 项目特定架构文档
|
||||
- **耗时**: 10-30 秒(比远程更快!)
|
||||
- **无需网络连接**
|
||||
|
||||
**输入:**
|
||||
```
|
||||
帮我把这个本地项目转成技能:./my-frontend-app
|
||||
```
|
||||
|
||||
**输出:**
|
||||
完整的前端框架文档,包括:
|
||||
- 组件结构和模式
|
||||
- 状态管理设置
|
||||
- 路由和导航
|
||||
- API 集成模式
|
||||
- 构建和部署命令
|
||||
- 本地开发工作流
|
||||
|
||||
---
|
||||
|
||||
## 📁 项目结构
|
||||
@@ -249,14 +321,14 @@ cp -r repo2skill your-project/.opencode/skills/
|
||||
```
|
||||
repo2skill/
|
||||
├── repo2skill/ # 🎯 主 Skill 目录(复制这个目录使用)
|
||||
│ ├── SKILL.md # 核心系统指令(397 行)
|
||||
│ ├── IMPLEMENTATION.md # 技术文档(165 行)
|
||||
│ ├── SKILL.md # 核心系统指令(~596 行,含本地支持)
|
||||
│ ├── IMPLEMENTATION.md # 技术文档(~240 行)
|
||||
│ ├── references/ # API 参考文档
|
||||
│ │ ├── github-api.md # GitHub API 速查表(123 行)
|
||||
│ │ ├── gitlab-api.md # GitLab API 速查表(114 行)
|
||||
│ │ └── gitee-api.md # Gitee API 速查表(31 行)
|
||||
│ └── scripts/ # 工具脚本
|
||||
│ └── utils.sh # Bash 辅助函数(95 行)
|
||||
│ └── utils.sh # Bash 辅助函数(~160 行,含本地支持)
|
||||
├── README.md # 英文主文档
|
||||
├── README_EN.md # 英文简版
|
||||
├── README_ZH.md # 本文件
|
||||
|
||||
+124
-22
@@ -19,32 +19,77 @@ repo2skill/
|
||||
|
||||
### How the Skill Executes
|
||||
|
||||
When a user asks to convert a repository:
|
||||
When a user asks to convert a repository or local path:
|
||||
|
||||
1. **URL Parsing** (Language tool: Regex matching in skill instructions)
|
||||
#### Remote Repository Flow
|
||||
|
||||
1. **Input Detection** (Step 0)
|
||||
- Distinguishes between remote URL and local path
|
||||
- Validates input format
|
||||
|
||||
2. **URL Parsing** (Step 1)
|
||||
- Detects platform (github/gitlab/gitee)
|
||||
- Extracts owner and repo name
|
||||
- Validates URL format
|
||||
|
||||
2. **Data Collection** (Tool: webfetch / bash curl)
|
||||
3. **Data Collection** (Step 2-3)
|
||||
- (Tool: webfetch / bash curl)
|
||||
- Fetches repository metadata via API
|
||||
- Gets README content
|
||||
- Retrieves file tree
|
||||
- Extracts key documentation files
|
||||
|
||||
|
||||
Mirror rotation is built into the skill via retry logic
|
||||
|
||||
3. **AI Analysis** (Tool: Configured LLM in OpenCode/Claude Code)
|
||||
4. **AI Analysis** (Step 5)
|
||||
- (Tool: Configured LLM in OpenCode/Claude Code)
|
||||
- Analyzes README and gathered content
|
||||
- Understands project structure
|
||||
- Identifies key features
|
||||
- Generates comprehensive documentation
|
||||
|
||||
4. **Skill Generation** (Tool: write)
|
||||
5. **Skill Generation** (Step 6-8)
|
||||
- (Tool: write)
|
||||
- Builds YAML frontmatter
|
||||
- Creates markdown sections
|
||||
- Writes SKILL.md to chosen location
|
||||
|
||||
#### Local Repository Flow (New)
|
||||
|
||||
1. **Input Detection** (Step 0)
|
||||
- Identifies local path input (./, /, ~, or existing directory)
|
||||
- Validates path exists
|
||||
|
||||
2. **Path Validation** (Step 3B.1)
|
||||
- Checks directory exists and is readable
|
||||
- Gets absolute path
|
||||
- Extracts project name
|
||||
|
||||
3. **File Extraction** (Step 3B.2-3B.6)
|
||||
- (Tools: read, glob, grep, bash)
|
||||
- Finds README files
|
||||
- Locates configuration files (package.json, requirements.txt, etc.)
|
||||
- Extracts documentation
|
||||
- Builds project structure understanding
|
||||
|
||||
4. **Metadata Inference** (Step 3B.4)
|
||||
- Detects project language from config files
|
||||
- Extracts description from README
|
||||
- Analyzes dependencies
|
||||
- Identifies project type
|
||||
|
||||
5. **AI Analysis** (Step 5)
|
||||
- (Tool: Configured LLM in OpenCode/Claude Code)
|
||||
- Analyzes extracted local files
|
||||
- Understands project structure
|
||||
- Generates comprehensive documentation
|
||||
|
||||
6. **Skill Generation** (Step 6-8)
|
||||
- (Tool: write)
|
||||
- Builds YAML frontmatter with local metadata
|
||||
- Creates markdown sections
|
||||
- Writes SKILL.md to chosen location
|
||||
|
||||
## Implementation Details
|
||||
|
||||
### Mirror Rotation Logic
|
||||
@@ -74,30 +119,35 @@ The skill does NOT hardcode LLM provider:
|
||||
|
||||
Only built-in OpenCode/Claude Code tools are used:
|
||||
|
||||
| Tool | Purpose |
|
||||
|------|---------|
|
||||
| `skill` | Load this skill's instructions |
|
||||
| `webfetch` | Fetch API responses |
|
||||
| `bash` | Execute curl for fallback API calls |
|
||||
| `read` | Read reference documents |
|
||||
| `write` | Write generated SKILL.md |
|
||||
| Configured LLM | Analyze and generate content |
|
||||
| Tool | Purpose | Remote Flow | Local Flow |
|
||||
|------|---------|-------------|------------|
|
||||
| `skill` | Load this skill's instructions | ✅ | ✅ |
|
||||
| `webfetch` | Fetch remote API responses | ✅ | ❌ |
|
||||
| `bash` | Execute commands (curl, path operations) | ✅ | ✅ |
|
||||
| `read` | Read files from disk | ✅ | ✅ (local files) |
|
||||
| `glob` | Find files by pattern | ❌ | ✅ (local discovery) |
|
||||
| `grep` | Search content in files | ❌ | ✅ (pattern analysis) |
|
||||
| `write` | Write generated SKILL.md | ✅ | ✅ |
|
||||
| Configured LLM | Analyze and generate content | ✅ | ✅ |
|
||||
|
||||
## For Users Installing This Skill
|
||||
|
||||
### What Happens When You Use It
|
||||
|
||||
#### Remote Repository Example
|
||||
|
||||
```
|
||||
User: "帮我把这个仓库转成技能:https://github.com/user/repo"
|
||||
```
|
||||
|
||||
**AI Process:**
|
||||
1. Loads repo2skill skill instructions
|
||||
2. Parses URL → detects GitHub, owner=user, repo=repo
|
||||
3. Calls webfetch/bash to get repo data from mirrors
|
||||
4. Retrieves README, metadata, file tree
|
||||
5. Uses configured LLM (Claude/GPT/etc.) to analyze
|
||||
6. Generates comprehensive SKILL.md with:
|
||||
2. Detects input type → Remote URL (Step 0)
|
||||
3. Parses URL → detects GitHub, owner=user, repo=repo (Step 1)
|
||||
4. Calls webfetch/bash to get repo data from mirrors (Steps 2-3)
|
||||
5. Retrieves README, metadata, file tree
|
||||
6. Uses configured LLM (Claude/GPT/etc.) to analyze (Step 5)
|
||||
7. Generates comprehensive SKILL.md with:
|
||||
- YAML frontmatter
|
||||
- Overview and features
|
||||
- Installation guide
|
||||
@@ -105,12 +155,48 @@ User: "帮我把这个仓库转成技能:https://github.com/user/repo"
|
||||
- API reference
|
||||
- Troubleshooting
|
||||
- Resources
|
||||
7. Asks user where to save:
|
||||
8. Asks user where to save:
|
||||
- `./.opencode/skills/repo-name/SKILL.md`
|
||||
- `~/.config/opencode/skills/repo-name/SKILL.md`
|
||||
- `~/.claude/skills/repo-name/SKILL.md`
|
||||
8. Writes the file
|
||||
9. Done!
|
||||
9. Writes the file
|
||||
10. Done!
|
||||
|
||||
#### Local Repository Example (New)
|
||||
|
||||
```
|
||||
User: "帮我把当前项目转成技能"
|
||||
OR
|
||||
User: "帮我把这个本地项目转成技能:./my-project"
|
||||
```
|
||||
|
||||
**AI Process:**
|
||||
1. Loads repo2skill skill instructions
|
||||
2. Detects input type → Local path (Step 0)
|
||||
3. Validates path → exists and is readable (Step 3B.1)
|
||||
4. Uses glob/grep/read to extract local files (Step 3B.3):
|
||||
- Finds README files
|
||||
- Locates config files (package.json, requirements.txt, etc.)
|
||||
- Builds project structure understanding
|
||||
5. Infers metadata from local files (Step 3B.4):
|
||||
- Detects language from config
|
||||
- Extracts description from README
|
||||
- Analyzes dependencies
|
||||
6. Uses configured LLM (Claude/GPT/etc.) to analyze (Step 5)
|
||||
7. Generates comprehensive SKILL.md with:
|
||||
- YAML frontmatter (with local metadata)
|
||||
- Overview and features
|
||||
- Installation guide
|
||||
- Usage examples
|
||||
- API reference (if applicable)
|
||||
- Troubleshooting
|
||||
- Resources
|
||||
8. Asks user where to save:
|
||||
- `./.opencode/skills/project-name/SKILL.md`
|
||||
- `~/.config/opencode/skills/project-name/SKILL.md`
|
||||
- `~/.claude/skills/project-name/SKILL.md`
|
||||
9. Writes the file
|
||||
10. Done!
|
||||
|
||||
### Why It Works
|
||||
|
||||
@@ -141,6 +227,7 @@ If the skill doesn't work:
|
||||
|
||||
## Performance
|
||||
|
||||
### Remote Repository
|
||||
Expected times:
|
||||
- Small repo (< 500 files): 30-60s
|
||||
- Medium repo (500-2k files): 1-2min
|
||||
@@ -153,6 +240,21 @@ Factors affecting speed:
|
||||
- LLM speed (model, provider)
|
||||
- Network connectivity
|
||||
|
||||
### Local Repository (New)
|
||||
Expected times:
|
||||
- Small project (< 500 files): 10-30s (faster, no network)
|
||||
- Medium project (500-2k files): 30-60s
|
||||
- Large project (2k+ files): 1-3min
|
||||
|
||||
Factors affecting speed:
|
||||
- File system I/O speed
|
||||
- Project size
|
||||
- Number of configuration files
|
||||
- README length
|
||||
- LLM speed (model, provider)
|
||||
|
||||
**Advantage**: Local analysis is typically **2-3x faster** than remote (no network latency, no mirror rotation)
|
||||
|
||||
## Security
|
||||
|
||||
- No user data sent to external services except open APIs
|
||||
|
||||
+284
-1
@@ -8,12 +8,65 @@ version: 1.0.0
|
||||
|
||||
## System Instructions
|
||||
|
||||
You are repo2skill, a specialized assistant that converts GitHub/GitLab/Gitee repositories into comprehensive OpenCode Skills.
|
||||
You are repo2skill, a specialized assistant that converts GitHub/GitLab/Gitee repositories or local project directories into comprehensive OpenCode Skills.
|
||||
|
||||
**When a user asks to convert a repository, follow this exact workflow:**
|
||||
|
||||
---
|
||||
|
||||
## Step 0: Input Detection
|
||||
|
||||
Detect the repository source type before proceeding:
|
||||
|
||||
### Platform Detection Patterns
|
||||
|
||||
**Remote Repository**
|
||||
- Contains domain: `github.com`, `gitlab.com`, or `gitee.com`
|
||||
- Examples:
|
||||
- `https://github.com/owner/repo`
|
||||
- `https://gitlab.com/owner/repo`
|
||||
- `https://gitee.com/owner/repo`
|
||||
- **Action**: Follow Steps 1-8 (Remote Repository Flow)
|
||||
|
||||
**Local Path**
|
||||
- Starts with `./` (relative path)
|
||||
- Starts with `/` (absolute path)
|
||||
- Starts with `~` (home directory)
|
||||
- Relative path that exists as directory
|
||||
- Examples:
|
||||
- `./my-project`
|
||||
- `/home/user/projects/my-app`
|
||||
- `~/workspace/project`
|
||||
- `my-project` (if directory exists)
|
||||
- **Action**: Follow Step 3B (Local Repository Extraction)
|
||||
|
||||
**Invalid Input**
|
||||
- Not a valid URL pattern
|
||||
- Not an existing local path
|
||||
- **Action**: Ask user to provide correct repository URL or local path
|
||||
|
||||
### Detection Logic
|
||||
|
||||
```bash
|
||||
# Check for remote URL
|
||||
if [[ $input =~ github\.com|gitlab\.com|gitee\.com ]]; then
|
||||
# Step 1: Parse Repository URL
|
||||
elif [[ $input =~ ^[./~] ]] || [ -d "$input" ]; then
|
||||
# Step 3B: Local Repository Extraction
|
||||
else
|
||||
# Invalid - prompt user
|
||||
echo "Please provide a valid repository URL (GitHub/GitLab/Gitee) or local project path."
|
||||
fi
|
||||
```
|
||||
|
||||
### Validation
|
||||
|
||||
- **Remote URL**: Extract owner/repo from URL pattern
|
||||
- **Local Path**: Verify directory exists using `bash -d "$path"`
|
||||
- **Fallback**: Offer guidance if validation fails
|
||||
|
||||
---
|
||||
|
||||
## Step 1: Parse Repository URL
|
||||
|
||||
Detect platform and extract repository information:
|
||||
@@ -120,6 +173,236 @@ Fetch important files:
|
||||
|
||||
---
|
||||
|
||||
## Step 3B: Local Repository Extraction
|
||||
|
||||
**Use this step when input is a local path (detected in Step 0)**
|
||||
|
||||
### 3B.1 Path Validation
|
||||
|
||||
```bash
|
||||
# Check if directory exists
|
||||
if [ ! -d "$path" ]; then
|
||||
echo "❌ Directory not found: $path"
|
||||
return 1
|
||||
fi
|
||||
|
||||
# Get absolute path
|
||||
absolute_path=$(cd "$path" && pwd)
|
||||
|
||||
# Verify it's a valid project directory
|
||||
# (has README or config files)
|
||||
```
|
||||
|
||||
### 3B.2 Project Metadata Extraction
|
||||
|
||||
```bash
|
||||
# Project name
|
||||
project_name=$(basename "$absolute_path")
|
||||
|
||||
# Git repository information (optional)
|
||||
if [ -d "$absolute_path/.git" ]; then
|
||||
git_remote=$(cd "$absolute_path" && git remote -v 2>/dev/null | head -1)
|
||||
git_branch=$(cd "$absolute_path" && git branch --show-current 2>/dev/null)
|
||||
git_description=$(cd "$absolute_path" && git describe --tags 2>/dev/null)
|
||||
fi
|
||||
```
|
||||
|
||||
### 3B.3 File Extraction Strategy
|
||||
|
||||
Use built-in tools to gather project structure:
|
||||
|
||||
| Tool | Purpose | Example |
|
||||
|------|---------|---------|
|
||||
| `read` | Read specific files | README.md, package.json |
|
||||
| `glob` | Find files by pattern | `**/*.md`, `**/package.json` |
|
||||
| `grep` | Search content | Function patterns, configs |
|
||||
| `bash` | Shell commands | `ls -la`, file operations |
|
||||
|
||||
**Key Files to Extract:**
|
||||
|
||||
1. **README files** (priority order):
|
||||
```
|
||||
glob **/README*
|
||||
# Try: README.md, README.txt, README.rst, README.adoc
|
||||
```
|
||||
|
||||
2. **Configuration files** (detect project type):
|
||||
```bash
|
||||
# JavaScript/TypeScript
|
||||
glob **/package.json
|
||||
glob **/tsconfig.json
|
||||
glob **/vite.config.js
|
||||
glob **/next.config.js
|
||||
|
||||
# Python
|
||||
glob **/requirements.txt
|
||||
glob **/pyproject.toml
|
||||
glob **/setup.py
|
||||
|
||||
# Rust
|
||||
glob **/Cargo.toml
|
||||
glob **/Cargo.lock
|
||||
|
||||
# Go
|
||||
glob **/go.mod
|
||||
glob **/go.sum
|
||||
|
||||
# Java/Maven
|
||||
glob **/pom.xml
|
||||
glob **/build.gradle
|
||||
|
||||
# Ruby
|
||||
glob **/Gemfile
|
||||
glob **/Gemfile.lock
|
||||
```
|
||||
|
||||
3. **Documentation**:
|
||||
```bash
|
||||
glob **/CONTRIBUTING.md
|
||||
glob **/CHANGELOG.md
|
||||
glob **/docs/**/*.md
|
||||
```
|
||||
|
||||
4. **Source structure** (limited for performance):
|
||||
```bash
|
||||
# Get top-level directories
|
||||
ls -d "$absolute_path"/*/
|
||||
|
||||
# Source directories (common patterns)
|
||||
ls "$absolute_path/src/" 2>/dev/null
|
||||
ls "$absolute_path/lib/" 2>/dev/null
|
||||
ls "$absolute_path/app/" 2>/dev/null
|
||||
```
|
||||
|
||||
### 3B.4 Metadata Inference
|
||||
|
||||
Since local repositories don't have API metadata, infer from files:
|
||||
|
||||
**Language Detection:**
|
||||
```bash
|
||||
# From config files
|
||||
if [ -f "package.json" ]; then
|
||||
language="JavaScript/TypeScript"
|
||||
elif [ -f "pyproject.toml" ]; then
|
||||
language="Python"
|
||||
elif [ -f "Cargo.toml" ]; then
|
||||
language="Rust"
|
||||
elif [ -f "go.mod" ]; then
|
||||
language="Go"
|
||||
fi
|
||||
|
||||
# From file extensions
|
||||
file_count=$(find "$absolute_path/src" -name "*.py" 2>/dev/null | wc -l)
|
||||
```
|
||||
|
||||
**Description Extraction:**
|
||||
```bash
|
||||
# From package.json
|
||||
description=$(grep -o '"description": ".*"' package.json | cut -d'"' -f4)
|
||||
|
||||
# From README first paragraph
|
||||
description=$(head -20 README.md | grep -A 5 "^#" | tail -1)
|
||||
```
|
||||
|
||||
**Dependencies Analysis:**
|
||||
```bash
|
||||
# Parse package.json dependencies
|
||||
dependencies=$(node -e "console.log(Object.keys(require('./package.json').dependencies).join(', '))")
|
||||
```
|
||||
|
||||
### 3B.5 Project Type Detection
|
||||
|
||||
| Indicators | Project Type |
|
||||
|------------|--------------|
|
||||
| package.json + vite/next/webpack | Frontend Web |
|
||||
| package.json + express/nestjs | Backend API |
|
||||
| requirements.txt + Django/Flask | Python Backend |
|
||||
| Cargo.toml | Rust Application |
|
||||
| go.mod | Go Application |
|
||||
| pom.xml | Java/Maven Project |
|
||||
| Gemfile | Ruby/Rails Project |
|
||||
|
||||
### 3B.6 Special Cases
|
||||
|
||||
**Git Repository with Remote:**
|
||||
```bash
|
||||
# If it's a git repo with remote, use remote URL as source
|
||||
git_url=$(cd "$absolute_path" && git remote get-url origin 2>/dev/null)
|
||||
|
||||
# Extract owner/repo from git remote
|
||||
if [[ $git_url =~ github\.com[:/]([^/]+)/([^/\.]+) ]]; then
|
||||
owner="${BASH_REMATCH[1]}"
|
||||
repo="${BASH_REMATCH[2]}"
|
||||
source="git"
|
||||
fi
|
||||
```
|
||||
|
||||
**Monorepo Structure:**
|
||||
```bash
|
||||
# Detect monorepo (multiple package.json or workspaces)
|
||||
if [ -f "$absolute_path/package.json" ] && [ -f "$absolute_path/package-lock.json" ]; then
|
||||
workspaces=$(grep -o '"workspaces": \[.*\]' "$absolute_path/package.json")
|
||||
if [ -n "$workspaces" ]; then
|
||||
project_type="Monorepo"
|
||||
fi
|
||||
fi
|
||||
```
|
||||
|
||||
### 3B.7 Performance Considerations
|
||||
|
||||
For local large repositories:
|
||||
|
||||
1. **Limit file listing depth**:
|
||||
```bash
|
||||
find "$absolute_path" -maxdepth 2 -type d
|
||||
```
|
||||
|
||||
2. **Prioritize documentation**:
|
||||
- Focus on README, docs/ directory
|
||||
- Skip node_modules/, .git/, build/, dist/
|
||||
|
||||
3. **Use sampling**:
|
||||
- Sample first 20 files from src/
|
||||
- Extract key config files only
|
||||
|
||||
### 3B.8 Error Handling
|
||||
|
||||
**Invalid Directory:**
|
||||
```
|
||||
❌ Unable to access local directory: {path}
|
||||
|
||||
Possible reasons:
|
||||
- Directory doesn't exist
|
||||
- No read permissions
|
||||
- Path contains invalid characters
|
||||
|
||||
Suggestions:
|
||||
1. Check the path is correct
|
||||
2. Verify you have read permissions
|
||||
3. Try using absolute path
|
||||
```
|
||||
|
||||
**No Project Files:**
|
||||
```
|
||||
⚠️ No recognizable project files found in {path}
|
||||
|
||||
Expected files (one or more of):
|
||||
- README.md
|
||||
- package.json / requirements.txt / Cargo.toml
|
||||
- go.mod / pom.xml
|
||||
|
||||
Falling back to basic analysis...
|
||||
```
|
||||
|
||||
**Large Directory Warning:**
|
||||
```
|
||||
⚠️ Large directory detected ({file_count} files)
|
||||
|
||||
Analysis may take longer. Continue? (y/n)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Step 4: Retry and Mirror Rotation Logic
|
||||
|
||||
### Retry Strategy
|
||||
|
||||
@@ -67,29 +67,92 @@ github_raw_fetch() {
|
||||
# Function: Extract repo info from URL
|
||||
parse_repo_info() {
|
||||
local url=$1
|
||||
|
||||
|
||||
# GitHub
|
||||
if [[ $url =~ github\.com/([^/]+)/([^/\?#]+) ]]; then
|
||||
echo "github ${BASH_REMATCH[1]} ${BASH_REMATCH[2]}"
|
||||
return 0
|
||||
fi
|
||||
|
||||
|
||||
# GitLab
|
||||
if [[ $url =~ gitlab\.com/([^/]+)/([^/\?#]+) ]]; then
|
||||
echo "gitlab ${BASH_REMATCH[1]} ${BASH_REMATCH[2]}"
|
||||
return 0
|
||||
fi
|
||||
|
||||
|
||||
# Gitee
|
||||
if [[ $url =~ gitee\.com/([^/]+)/([^/\?#]+) ]]; then
|
||||
echo "gitee ${BASH_REMATCH[1]} ${BASH_REMATCH[2]}"
|
||||
return 0
|
||||
fi
|
||||
|
||||
|
||||
return 1
|
||||
}
|
||||
|
||||
# Function: Check if input is a local path
|
||||
is_local_path() {
|
||||
local input=$1
|
||||
|
||||
# Check if starts with ./ (relative path)
|
||||
if [[ $input =~ ^\./ ]]; then
|
||||
return 0
|
||||
fi
|
||||
|
||||
# Check if starts with / (absolute path)
|
||||
if [[ $input =~ ^/ ]]; then
|
||||
return 0
|
||||
fi
|
||||
|
||||
# Check if starts with ~ (home directory)
|
||||
if [[ $input =~ ^~ ]]; then
|
||||
return 0
|
||||
fi
|
||||
|
||||
# Check if directory exists (relative path)
|
||||
if [ -d "$input" ]; then
|
||||
return 0
|
||||
fi
|
||||
|
||||
# Not a local path
|
||||
return 1
|
||||
}
|
||||
|
||||
# Function: Parse local repository information
|
||||
parse_local_info() {
|
||||
local path=$1
|
||||
|
||||
# Validate directory exists
|
||||
if [ ! -d "$path" ]; then
|
||||
echo "ERROR: Directory not found: $path"
|
||||
return 1
|
||||
fi
|
||||
|
||||
# Get absolute path
|
||||
local abs_path
|
||||
abs_path=$(cd "$path" && pwd 2>/dev/null)
|
||||
if [ -z "$abs_path" ]; then
|
||||
echo "ERROR: Unable to get absolute path for: $path"
|
||||
return 1
|
||||
fi
|
||||
|
||||
# Get repository name (directory name)
|
||||
local repo_name
|
||||
repo_name=$(basename "$abs_path")
|
||||
|
||||
# Get git remote URL if available
|
||||
local git_remote=""
|
||||
if [ -d "$abs_path/.git" ]; then
|
||||
git_remote=$(cd "$abs_path" && git remote get-url origin 2>/dev/null || echo "")
|
||||
fi
|
||||
|
||||
# Format output: type absolute_path repo_name git_remote
|
||||
echo "local ${abs_path} ${repo_name} ${git_remote}"
|
||||
return 0
|
||||
}
|
||||
|
||||
# Export functions
|
||||
export -f github_api_fetch
|
||||
export -f github_raw_fetch
|
||||
export -f parse_repo_info
|
||||
export -f is_local_path
|
||||
export -f parse_local_info
|
||||
|
||||
Reference in New Issue
Block a user