<div align="center">

GitHub 存档

一个强大的工具，可同时克隆、拉取或复刻用户和组织的仓库和 Gist，以创建 GitHub 存档。

</div>

GitHub 存档是一个强大的工具，可以灵活地同时克隆、拉取或复刻 GitHub 上的仓库或 Gist。它是启动新开发环境、保存 GitHub 实例本地副本或快速拉取你喜欢的用户和组织项目的完美工具。

GitHub 存档的强大之处在于其配置。也许你只想克隆或拉取你的个人公开仓库，或者你想全面包括你和你所属的所有组织的私有仓库以及你的 Gist。GitHub 存档可以做到这一切。

安装

# 安装工具
pip3 install github-archive

# 本地安装
just install

使用方法

用法：
    github-archive --users justintime50 --clone

选项：
    -h, --help            显示此帮助信息并退出
    -t TOKEN, --token TOKEN
                            提供你的 GitHub 令牌以验证 GitHub API 并获取私有仓库和 Gist 的访问权限。
    -u USERS, --users USERS
                            传递以逗号分隔的用户列表以获取仓库。
    -o ORGS, --orgs ORGS  传递以逗号分隔的组织列表以获取仓库。
    -g GISTS, --gists GISTS
                            传递以逗号分隔的用户列表以获取 Gist。
    -s STARS, --stars STARS
                            传递以逗号分隔的用户列表以获取已加星标的仓库。
    -v, --view            传递此标志以查看 Git 资产（干运行）。
    -c, --clone           传递此标志以克隆 Git 资产。
    -p, --pull            传递此标志以拉取 Git 资产。
    -f, --fork            传递此标志以复刻 Git 资产。
    --include INCLUDE     传递以逗号分隔的仓库列表，以过滤存档中包含的内容。
    --exclude EXCLUDE     传递以逗号分隔的仓库列表，以过滤存档中排除的内容。
    --forks               传递此标志以包含复刻的 Git 资产（克隆或拉取时）。
    --location LOCATION   你想存储 GitHub 存档的位置。默认：/Users/USERNAME/github-archive
    --https               使用 HTTPS URL 而不是 SSH。
    --timeout TIMEOUT     Git 操作超时前的秒数。默认：300
    --threads THREADS     要运行的并发线程数。默认：10
    --base_url BASE_URL   GitHub 实例的基本 URL（对于使用自定义主机名的企业用户有用）。默认：https://api.github.com
    --log_level {error,critical,warning,info,debug}
                            工具使用的日志级别。默认：info
    --version             显示程序的版本号并退出

身份验证

此工具有三种身份验证方法。

未经身份验证

你可以运行类似 github-archive --users justintime50 --clone 的命令，这只会克隆公共仓库。GitHub 有每小时 60 个请求的硬性限制 - 如果不进行身份验证，可能会在存档大型 GitHub 实例时快速用完这个限制。

SSH

为了让脚本持续运行而不需要为每个仓库输入密码，你可以将 SSH 密码添加到 SSH 代理：

# 这假设你已将 SSH 密钥保存到默认位置
ssh-add

然后你可以运行类似 github-archive --users justintime50 --clone --token 123 的命令，其中 token 是你的 GitHub API 令牌。这将通过 token 验证你的 GitHub API 身份，并通过 ssh 验证 GitHub 身份。

Git 凭证管理器

或者，你可以使用像 Git 凭证管理器 这样的工具来在后台填充你的 Git 凭证。当不使用 SSH 时，我们将从 git URL 而不是 SSH URL 克隆/拉取。要触发此行为，你必须传递 --https 标志。

然后你可以运行类似 github-archive --users justintime50 --clone --token 123 --https 的命令，其中 token 是你的 GitHub API 令牌。这将通过 token 验证你的 GitHub API 身份，并通过 GCM 使用你的 Git 凭证验证 GitHub 身份。

注意事项

访问权限：GitHub 存档只能克隆或拉取经过身份验证的用户有权访问的 Git 资产。这意味着你无法克隆或拉取你无权访问的其他用户或组织的私有仓库。此外，如果不使用令牌和 SSH/CGM，你将无法与私有 Git 资产交互。

合并冲突：请注意，如果你将这些仓库用作活跃的开发仓库而不是简单的存档或一次性克隆，使用 GitHub 存档可能会导致合并冲突，除非你提交或暂存你的更改。

开发

# 获取全面的开发工具列表
just --list

# 在本地运行工具
venv/bin/python github_archive/cli.py --help