gitload

使用 gitload 命令行工具从 GitHub URL 下载文件、文件夹或整个代码库。

使用场景

在以下情况使用 gitload：

• 从代码库下载特定文件夹（而非整个代码库）
• 从 GitHub 获取单个文件
• 下载代码库内容但不包含 git 历史记录
• 创建 GitHub 内容的 ZIP 归档文件
• 通过身份验证访问私有代码库

在以下情况请勿使用 gitload：

• 需要完整的 git 历史记录时（请改用git clone命令）
• 代码库已本地克隆时
• 处理非 GitHub 代码库时

前提条件

通过 npx 运行 gitload（无需安装）：

npx gitload-cli https://github.com/user/repo

或全局安装：

npm install -g gitload-cli

基本用法

下载整个代码库

gitload https://github.com/user/repo

创建一个repo/当前目录下的文件夹。

下载指定文件夹

gitload https://github.com/user/repo/tree/main/src/components

创建一个components/文件夹，仅包含该文件夹的内容。

下载单个文件

gitload https://github.com/user/repo/blob/main/README.md

下载到自定义位置

gitload https://github.com/user/repo/tree/main/src -o ./my-source

将内容扁平化下载到当前目录

gitload https://github.com/user/repo/tree/main/templates -o .

以ZIP格式下载

gitload https://github.com/user/repo -z ./repo.zip

身份验证（用于私有仓库或速率限制）

使用gh CLI（推荐）

gitload https://github.com/user/private-repo --gh

需要先执行gh auth login。

使用显式令牌

gitload https://github.com/user/repo --token ghp_xxxx

使用环境变量

export GITHUB_TOKEN=ghp_xxxx
gitload https://github.com/user/repo

令牌优先级： --token>GITHUB_TOKEN>--gh

URL格式

gitload接受标准的GitHub URL：

• 仓库根目录： https://github.com/user/repo
• 文件夹： https://github.com/user/repo/tree/branch/path/to/folder
• 文件： https://github.com/user/repo/blob/branch/path/to/file.ext

常见模式

从模板文件夹搭建项目

gitload https://github.com/org/templates/tree/main/react-starter -o ./my-app
cd my-app && npm install

获取示例代码

gitload https://github.com/org/examples/tree/main/authentication

下载文档以供离线阅读

gitload https://github.com/org/project/tree/main/docs -z ./docs.zip

获取单个配置文件

gitload https://github.com/org/configs/blob/main/.eslintrc.json -o .

选项参考

错误处理

如果 gitload 失败：

1. 404 错误：请验证 URL 是否存在且可访问
2. 速率限制错误：请通过--gh或--token
3. 添加身份验证权限错误：对于私有仓库，请确保令牌具有repo
4. 范围网络错误：

检查网络连接

• 注意
• gitload 通过 GitHub 的 API 下载内容，而非 git 协议不保留 git 历史记录（请使用（如需历史记录）
• 大型代码库可能需要较长时间；建议下载特定文件夹
• 若输出目录不存在则会自动创建