GitHub-Backup 技术文档

1. 安装指南

1.1 环境依赖

GitHub-Backup 需要使用 PyGitHub Python 包，支持 GitHub API v3。

1.2 安装步骤

使用以下命令进行安装：

pip install git+https://github.com/clockfort/GitHub-Backup

2. 项目使用说明

GitHub-Backup 用于备份 GitHub 用户（或 GitHub 组织）的所有仓库至本地。

2.1 使用方法

运行以下命令：

github-backup.py login_or_token backupdir

其中：

• login_or_token: GitHub 用户名或认证令牌。
• backupdir: 备份文件存放的目录。

2.2 命令行参数

以下是部分常用的命令行参数：

• -h, --help: 显示帮助信息并退出。
• -v {all,public,private}, --visibility {all,public,private}: 按仓库可见性过滤。
• -a {owner,collaborator,organization_member}, --affiliation {owner,collaborator,organization_member}: 按仓库归属关系过滤。
• -d, --debug: 显示调试信息。
• -q, --quiet: 只显示错误信息。
• -m, --mirror: 创建一个裸镜像。
• -f, --skip-forks: 跳过副本仓库。
• --skip-repos: 跳过备份仓库。

更多参数请参考项目 readme 文件。

3. 项目API使用文档

GitHub-Backup 使用 PyGitHub 包与 GitHub API 进行交互。具体 API 使用方式请参考 PyGitHub 文档。

4. 项目安装方式

安装方法已在 1. 安装指南 中说明。使用 pip 命令安装本项目即可。