degit 使用教程

degit 是一个非常实用的命令行工具，它的主要功能是快速地从 Git 仓库（如 GitHub、GitLab、Bitbucket 等）克隆项目模板或代码。与 git clone 不同，degit 不会复制整个 Git 历史记录，而是直接下载仓库特定分支或标签的最新快照（通常是 .tar.gz 压缩包），这使得它在获取项目模板时速度非常快且简洁。

什么是 degit？

当你需要基于某个模板快速启动一个新项目时，degit 是一个理想的选择。例如，许多前端框架（如 Svelte、Vue 等）的官方模板都推荐使用 degit 来初始化项目。它只关心最新的代码，不关心历史版本，因此下载的文件体积小，速度快。

安装

degit 是一个 Node.js 包，你可以通过 npm 或 yarn 进行安装。

1. 全局安装（推荐，方便在任何地方使用）：

npm install -g degit
# 或者使用 yarn
yarn global add degit

安装后，你就可以在终端直接使用 degit 命令了。

2. 使用 npx (无需全局安装)：

如果你不想全局安装，也可以在每次使用时通过 npx 来运行：

npx degit <参数...>

使用方法

degit 的基本语法非常简单：

degit <user>/<repo> [<destination>] [options]

• <user>/<repo>: 指定要克隆的仓库，默认从 GitHub 获取。
• [<destination>]: 可选参数，指定下载内容存放的目标目录。如果省略，将使用当前目录。如果目录不存在，degit 会自动创建。

示例：

1. 从 GitHub 克隆仓库到指定目录：

假设你想使用 Svelte 的官方模板创建一个名为 my-svelte-app 的新项目：

degit sveltejs/template my-svelte-app

这会把 github.com/sveltejs/template 仓库的最新代码下载到 my-svelte-app 文件夹中。

2. 克隆到当前目录：

如果你已经在目标目录中，可以省略 destination 参数：

# 首先创建并进入目录
mkdir my-new-project && cd my-new-project
# 然后在当前目录克隆
degit someuser/some-repo

3. 指定代码托管平台：

degit 默认使用 GitHub。如果你想从 GitLab 或 Bitbucket 克隆，需要添加前缀：

• GitLab: degit gitlab:<user>/<repo>
• Bitbucket: degit bitbucket:<user>/<repo>
• Sourcehut: degit sourcehut:<user>/<repo>

# 从 GitLab 克隆
degit gitlab:gitlab-org/gitlab-foss my-gitlab-project

# 从 Bitbucket 克隆
degit bitbucket:atlassian/react-beautiful-dnd my-dnd-app

4. 指定分支、标签或 Commit:

默认情况下，degit 会克隆仓库的默认分支（通常是 main 或 master）。你可以通过在仓库名后添加 # 来指定特定的分支、标签 (tag) 或 Commit SHA：

# 克隆 'dev' 分支
degit user/repo#dev my-dev-branch

# 克隆 v2.0.0 标签
degit user/repo#v2.0.0 my-v2-project

# 克隆特定的 commit
degit user/repo#1a2b3c4d my-specific-commit

5. 克隆仓库的子目录：

有时你可能只需要仓库中的某个子目录，而不是整个仓库。degit 也支持这种用法：

# 只克隆 user/repo 仓库下的 src/components 目录
degit user/repo/src/components my-components

6. 强制覆盖：

如果目标目录已存在且不为空，degit 默认会报错并停止执行，以防止意外覆盖文件。如果你确定要覆盖，可以使用 --force 或 -f 选项：

degit sveltejs/template my-existing-app --force

7. 缓存：

degit 会将下载的仓库 tar 包缓存在本地（通常在用户主目录的 .degit 文件夹下），这样下次再克隆同一个仓库/分支/标签时速度会更快。

总结

degit 是一个轻量、快速且易于使用的工具，特别适用于：

• 从模板仓库初始化新项目。
• 快速获取某个仓库的最新代码快照，而不需要完整的 Git 历史。
• 下载仓库的特定部分（分支、标签、子目录）。

当你需要快速开始一个项目原型或使用标准化的项目结构时，degit 是一个非常方便的选择。