GitHub CLI 技术文档

GitHub CLI 技术文档

cli cli/cli: cli (GitHub CLI) 是GitHub官方提供的命令行工具，允许开发者在终端中更加方便地与GitHub进行交互，执行如创建pull request、管理仓库、查看议题等操作。 项目地址: https://gitcode.com/gh_mirrors/cli/cli

GitHub CLI (gh) 是一款将 GitHub 功能带入命令行的工具，旨在无缝整合 git 工作流程与 GitHub 操作。适用于 GitHub.com 和 GitHub Enterprise Server 2.20 及以上版本，支持macOS、Windows以及Linux操作系统。以下是详细的技术文档，帮助您了解和使用GitHub CLI。

安装指南

macOS

对于macOS用户，gh可以通过多种方式安装，包括：

• Homebrew: 使用命令行输入 brew install gh 进行安装，升级则为 brew upgrade gh。
• MacPorts: 执行 sudo port install gh 进行安装，升级时运行 sudo port selfupdate && sudo port upgrade gh。
• Conda, Spack, Webi, 或者直接从 releases page 下载包含.pkg的安装包进行安装。请注意，.pkg文件目前未签名。

Linux & BSD

在Linux和BSD系统上，除了通过社区维护的特定发行版仓库外，还可以利用Homebrew、Conda、Spack或直接下载预编译二进制文件来安装。具体详情请参考 Linux & BSD安装文档。

Windows

Windows用户可选择WinGet、Scoop、Chocolatey、Conda或直接从 releases 页面下载MSI安装文件。例如，通过WinGet安装使用 winget install --id GitHub.cli，升级则是 winget upgrade --id GitHub.cli。

其他平台

其他平台的用户可以从 releases page 直接下载适合的操作系统版本的二进制文件。

从源码构建

对于希望自定义编译的开发者，可以参照 从源码构建指南。

项目使用说明

1. 初始化: 首次使用建议通过 gh auth login 命令登录您的GitHub账户，以解锁完整功能。
2. 基本操作: 常用命令如创建issue (gh issue create), 提交pull request (gh pr create) 等，具体使用方法请参考 官方手册。

API使用文档

GitHub CLI本身提供了丰富的命令行接口，这些可以直接视为对GitHub REST API的封装。每个命令通常对应于一系列API调用，详细的API交互可以通过查看 gh api 命令的帮助文档来了解，它允许直接与GitHub API交互，探索资源、执行操作等。

总结

本文档提供了一个基础框架用于理解和应用GitHub CLI，涵盖了安装过程、基本使用说明，以及简要的API互动指引。深入学习和掌握更多高级特性，推荐访问其官方文档和手动页面。在使用过程中遇到任何困难，欢迎贡献反馈或参与开源项目的贡献。

cli cli/cli: cli (GitHub CLI) 是GitHub官方提供的命令行工具，允许开发者在终端中更加方便地与GitHub进行交互，执行如创建pull request、管理仓库、查看议题等操作。 项目地址: https://gitcode.com/gh_mirrors/cli/cli