GitHub CLI

image

GitHub CLI(命令行界面)是一款开源工具,允许用户直接从命令行操作 GitHub 仓库。

使用 GitHub CLI,开发者可以减少在终端和浏览器之间切换的频率,从而提高工作效率。

以下是关于 GitHub CLI 的详细手把手教程。

1. 安装 GitHub CLI

1.1. Windows

  1. 访问 GitHub CLI 的 安装页面。

  2. 下载适用于 Windows 的安装包(MSI 文件)。

  3. 运行安装包并按照提示完成安装。

  4. 你也可以使用包管理器如 Scoop 来安装:

    # 使用 Scoop 安装 GitHub CLI
    scoop install gh
    

1.2. macOS

  1. 使用 Homebrew 安装:

    # 使用 Homebrew 安装 GitHub CLI
    brew install gh
    

1.3. Linux

  1. 访问 GitHub CLI 的 安装页面。

  2. 下载适用于 Linux 的安装包(.deb 或 .rpm 文件)。

  3. 使用以下命令安装(以 .deb 文件为例):

    # 安装 GitHub CLI 的 .deb 包
    sudo dpkg -i gh_*_linux_amd64.deb
    

2. 配置 GitHub CLI

  1. 运行以下命令进行身份验证:

    # 进行身份验证
    gh auth login
    

    按照提示在浏览器中完成授权。

  2. 设置首选编辑器:

    # 设置首选编辑器
    gh config set editor <editor>
    

    例如,设置为 VS Code:

    # 设置 VS Code 为首选编辑器
    gh config set editor "code --wait"
    

3. 常用命令

3.1. 仓库操作

  • 克隆仓库

    # 克隆指定的 GitHub 仓库
    gh repo clone <owner>/<repo>
    

    示例:

    # 克隆 GitHub CLI 的官方仓库
    gh repo clone cli/cli
    
  • 创建新仓库

    # 创建一个新的 GitHub 仓库
    gh repo create <repo-name>
    

    示例:

    # 创建一个名为 my-new-repo 的新仓库
    gh repo create my-new-repo
    
  • 复刻并克隆仓库

    # 复刻并克隆指定的 GitHub 仓库
    gh repo fork <owner>/<repo> --clone
    

    示例:

    # 复刻并克隆 GitHub CLI 的官方仓库
    gh repo fork cli/cli --clone
    

3.2. Issue 管理

  • 列出所有 Issue

    # 列出当前仓库中的所有 Issue
    gh issue list
    

    示例:

    # 列出当前仓库中的所有 Issue
    gh issue list
    
  • 创建新 Issue

    # 创建一个新的 Issue
    gh issue create
    

    示例:

    # 创建一个新的 Issue,按照提示输入标题和描述
    gh issue create
    
  • 查看特定 Issue

    # 查看指定编号的 Issue
    gh issue view <issue-number>
    

    示例:

    # 查看编号为 123 的 Issue
    gh issue view 123
    

3.3. Pull Request 管理

  • 列出所有 Pull Request

    # 列出当前仓库中的所有 Pull Request
    gh pr list
    

    示例:

    # 列出当前仓库中的所有 Pull Request
    gh pr list
    
  • 创建新 Pull Request

    # 创建一个新的 Pull Request
    gh pr create
    

    示例:

    # 创建一个新的 Pull Request,按照提示输入标题和描述
    gh pr create
    
  • 查看特定 Pull Request

    # 查看指定编号的 Pull Request
    gh pr view <pr-number>
    

    示例:

    # 查看编号为 456 的 Pull Request
    gh pr view 456
    

4. 高级用法

4.1. 别名设置

你可以为常用命令设置别名,以提高效率:

# 设置别名,将'pr checkout'命令简化为'co'
gh alias set co 'pr checkout'

这样你可以使用 gh co <pr-number> 来检出 Pull Request。

4.2. 与 GitHub Actions 集成

GitHub CLI 支持与 GitHub Actions 集成,可以在工作流中使用:

# 列出所有运行的 GitHub Actions
gh run list

# 查看指定运行 ID 的 GitHub Actions
gh run view <run-id>

5. 图表辅助理解

5.1. 安装流程图

graph TD;
    A[访问GitHub CLI安装页面] --> B[下载适用于操作系统的安装包];
    B --> C[运行安装包];
    C --> D[完成安装];

5.2. 常用命令示例图

graph TD;
    A[仓库操作] --> B[克隆仓库];
    A --> C[创建新仓库];
    A --> D[复刻并克隆仓库];
    E[Issue管理] --> F[列出所有Issue];
    E --> G[创建新Issue];
    E --> H[查看特定Issue];
    I[Pull Request管理] --> J[列出所有Pull Request];
    I --> K[创建新Pull Request];
    I --> L[查看特定Pull Request];

6. 总结

GitHub CLI 是一个强大的工具,能够显著提高开发者在 GitHub 上的工作效率。

通过熟练掌握上述命令和配置,你可以在命令行中完成大部分 GitHub 操作,减少在浏览器和终端之间的切换,提高工作效率。

希望这个手把手教学文档对你有所帮助!如果有任何问题,欢迎随时提问。