# github-proxy-skill

**Repository Path**: pythonxueba/github-proxy-skill

## Basic Information

- **Project Name**: github-proxy-skill
- **Description**: GitHub 代理工具 - Claude Code 技能，提供镜像搜索、代理访问和下载功能
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-02-02
- **Last Updated**: 2026-02-02

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# GitHub 代理技能 - Claude Code 技能

这是完整的 GitHub 代理工具，为 Claude Code 提供 GitHub 镜像搜索、代理访问和下载功能。

## 功能特性

### 🚀 核心功能

1. **自动镜像选择**
   - 自动检测可用性并选择最快的镜像站
   - 支持多个镜像源，确保高可用性
   - 实时镜像状态检测

2. **GitHub 仓库搜索**
   - 通过镜像站搜索 GitHub 仓库
   - 返回 20 条最相关的搜索结果
   - 所有链接自动替换为镜像地址

3. **文件下载**
   - 通过镜像站下载 GitHub 原始文件
   - 支持指定分支
   - 高速下载，不受 GitHub 限制

4. **仓库信息获取**
   - 通过镜像获取仓库基本信息
   - 代理访问仓库页面

### 📦 支持的镜像站

- **bgithub.xyz** - 快速 GitHub 镜像
- **kkgithub.com** - 稳定的 GitHub 克隆镜像
- **gitclone.com** - GitHub 克隆加速服务
- **github.ur1.fun** - GitHub 快速访问镜像
- **hub.fastgit.xyz** - 高速 GitHub 镜像
- **ghproxy.com** - GitHub 代理服务

## 目录结构

```
github-proxy-skill/
├── skill.json              # Claude Code 技能清单
├── README.md               # 说明文档（本文件）
├── github.py              # 主程序和技能类
└── examples.py            # 使用示例
```

## 使用方法

### 方法 1: 命令行运行

```bash
python3 github.py
```

运行后会提示输入搜索关键词：
```
请输入 GitHub 搜索关键词：godot
```

### 方法 2: 作为 Claude Code 技能

在 Claude Code 中加载此技能后，可以直接调用：

#### 搜索仓库
```python
from github import GitHubProxySkill

skill = GitHubProxySkill()
result = skill.search_repositories("godot")

# 返回结果包含：
# - success: 是否成功
# - mirror: 使用的镜像站
# - keyword: 搜索关键词
# - results: 搜索结果列表
# - count: 结果数量
```

#### 下载文件
```python
from github import GitHubProxySkill

skill = GitHubProxySkill()
file_result = skill.get_raw_file(
    owner="godotengine",
    repo="godot-docs",
    file_path="README.md",
    branch="main"
)

# 返回结果包含：
# - success: 是否成功
# - mirror: 使用的镜像站
# - file_path: 文件路径
# - content: 文件内容
# - url: 镜像 URL
```

#### 获取仓库信息
```python
from github import GitHubProxySkill

skill = GitHubProxySkill()
info_result = skill.get_repository_info(
    owner="godotengine",
    repo="godot-docs"
)

# 返回结果包含：
# - success: 是否成功
# - mirror: 使用的镜像站
# - owner: 仓库所有者
# - repo: 仓库名称
# - url: 镜像 URL
# - status_code: HTTP 状态码
```

#### 获取技能信息
```python
from github import GitHubProxySkill

skill = GitHubProxySkill()
skill_info = skill.get_skill_info()

# 返回技能元数据
```

### 方法 3: 搜索结果 JSON 文件

搜索后会自动生成 `github_search_results.json` 文件，包含完整的搜索结果：

```json
{
  "success": true,
  "mirror": "https://bgithub.xyz",
  "keyword": "godot",
  "results": [
    {
      "name": "godot",
      "full_name": "godotengine/godot",
      "html_url": "https://bgithub.xyz/godotengine/godot",
      "description": "Godot Engine – A feature-packed, ...",
      "stars": 82345,
      "forks": 15782,
      "language": "C++",
      "updated_at": "2024-01-15T10:30:00Z",
      "owner": {
        "login": "godotengine",
        "avatar_url": "https://avatars.githubusercontent.com/u/...",
        "html_url": "https://bgithub.xyz/godotengine"
      }
    }
  ],
  "count": 20
}
```

## API 接口说明

### GitHubProxySkill 类

#### 初始化
```python
skill = GitHubProxySkill()
```

初始化时会自动检测可用的镜像站。

#### 方法列表

##### 1. `get_skill_info() -> Dict`
返回技能的元数据信息。

**返回值：**
- `name`: 技能名称
- `version`: 技能版本
- `description`: 技能描述
- `author`: 作者
- `capabilities`: 技能能力列表

##### 2. `search_repositories(keyword: str) -> Dict`
通过镜像站搜索 GitHub 仓库。

**参数：**
- `keyword`: 搜索关键词

**返回值：**
- `success`: 布尔值，搜索是否成功
- `mirror`: 使用的镜像站 URL
- `keyword`: 搜索关键词
- `results`: 搜索结果列表
- `count`: 结果数量

##### 3. `get_raw_file(owner: str, repo: str, file_path: str, branch: str = "main") -> Dict`
获取 GitHub 仓库中的原始文件内容。

**参数：**
- `owner`: 仓库所有者
- `repo`: 仓库名称
- `file_path`: 文件路径
- `branch`: 分支名称（默认为 "main"）

**返回值：**
- `success`: 布尔值，下载是否成功
- `mirror`: 使用的镜像站 URL
- `file_path`: 文件路径
- `content`: 文件内容
- `url`: 镜像 URL
- `error`: 错误信息（如果失败）

##### 4. `get_repository_info(owner: str, repo: str) -> Dict`
获取仓库信息。

**参数：**
- `owner`: 仓库所有者
- `repo`: 仓库名称

**返回值：**
- `success`: 布尔值，请求是否成功
- `mirror`: 使用的镜像站 URL
- `owner`: 仓库所有者
- `repo`: 仓库名称
- `url`: 镜像 URL
- `status_code`: HTTP 状态码
- `error`: 错误信息（如果失败）

## 技术细节

### 镜像替换逻辑

所有包含 `github.com` 的 URL 都会自动替换为镜像域名：

```python
# 原始 URL
https://github.com/godotengine/godot

# 替换后
https://bgithub.xyz/godotengine/godot
```

### 搜索流程

1. 使用 GitHub 原站 API 进行搜索（稳定性更高）
2. 处理搜索结果，提取 20 条最相关结果
3. 将所有 GitHub URL 替换为镜像地址
4. 返回结构化的 JSON 结果

### 错误处理

技能包含完善的错误处理：

- **网络连接错误**: 提示检查网络
- **HTTP 错误**: 显示状态码和错误信息
- **JSON 解析错误**: 提示响应格式问题
- **镜像不可用**: 提示检查镜像配置

## 依赖项

- Python >= 3.7
- requests >= 2.28.0

安装依赖：
```bash
pip install requests
```

## 许可证

MIT License

## 作者

pythonxueba

## 反馈与支持

如有问题或建议，请访问：
https://gitee.com/pythonxueba/github-proxy-skill

## 更新日志

### v1.0.0 (2024-02-02)
- ✨ 初始版本发布
- ✨ 支持 GitHub 镜像搜索
- ✨ 支持文件下载
- ✨ 支持仓库信息获取
- ✨ 自动镜像选择
- ✨ Claude Code 技能接口