michaelin/github-cli

github-cli

镜像概述和主要用途

github-cli 是一个封装了 https://github.com/cli/cli 的Docker容器。镜像可在 https://hub.docker.com/r/michaelin/github-cli 获取。

该容器允许用户无需手动构建和安装Github CLI，即可直接使用其功能，同时支持轻松切换不同版本的工具进行测试和使用。

核心功能和特性

• 免安装依赖：无需在本地系统安装Github CLI及其依赖，仅需Docker环境即可使用
• 版本灵活切换：通过运行不同版本的容器，轻松切换Github CLI版本
• 透明使用体验：通过包装脚本或别名，使容器内工具的使用方式与本地安装工具一致
• 配置持久化：认证信息和配置存储在本地，确保容器重启后配置不丢失
• 安全的SSH集成：通过SSH代理而非容器内存储私钥的方式，安全使用SSH访问Github

使用场景和适用范围

• 需要使用Github CLI但不想在本地系统安装的用户
• 需测试不同版本Github CLI功能的开发者
• 在隔离环境中使用命令行工具的场景
• 需要在多台设备间快速部署一致Github CLI环境的用户

详细使用方法和配置说明

什么是CLI容器？

CLI容器是包装单一命令行工具的Docker容器，允许用户以透明方式替代本地安装的工具。其优势在于：

• 避免安装任何依赖（仅需Docker）
• 通过运行不同版本容器轻松切换工具版本
• 可通过包装脚本在其他脚本中使用（别名无法实现此功能）

使用包装脚本运行容器

1. 将 gh 脚本复制到环境变量 PATH 包含的目录，例如 $HOME/.local/bin
2. 运行以下命令确保脚本可执行：

   bash
   chmod +x $HOME/.local/bin/gh
   

3. 执行 gh auth login 生成认证令牌并配置工具
4. 现在可运行任何 gh 命令，例如：

   bash
   gh repo view cli/cli
   gh repo clone cli/cli
   

配置说明

Github CLI正常工作需要以下配置：

• 访问令牌：确保在Github中拥有必要权限
• SSH密钥（如使用SSH访问Github）：需让gh能够访问SSH密钥

认证令牌

gh auth login 命令会引导生成认证令牌，令牌及相关配置存储在本地 $HOME/.config/gh 目录。容器运行时会挂载该目录，确保认证和配置在多次运行间持久化。

SSH密钥

SSH密钥通过本地SSH代理提供给容器，避免在容器内存储私钥，提高安全性：

1. 启动SSH代理：

   bash
   eval $(ssh-agent -s)
   

2. 将SSH密钥添加到代理：

   bash
   ssh-add /path/to/keyfile
   

包装脚本会自动发现当前活动的SSH代理，并使其在容器内可用。关于SSH代理的详细安全注意事项，建议阅读 The pitfalls of using ssh-agent, or how to use an agent safely。

通过网页浏览器登录

gh auth login 向导支持 "Login with a web browser" 选项，这是最简单的登录方式。由于容器内无浏览器，自动打开浏览器会失败，解决方法：

1. 手动复制向导中提供的URL到本地浏览器
2. 在浏览器中完成验证后，复制一次性令牌
3. 将令牌粘贴回向导中完成认证

认证信息会存储在本地 $HOME/.config/gh 目录。

粘贴认证令牌

作为浏览器登录的替代方式，可手动创建认证令牌：

1. 在 https://github.com/settings/tokens 创建令牌
2. 令牌需至少包含 repo 和 read:org 权限
3. 将生成的令牌粘贴到 gh auth login 向导中完成配置

本地构建镜像

默认构建 trunk 分支的最新版本：

bash
docker build . -t michaelin/github-cli

构建特定标签或分支，需传递 CLI_VERSION 构建参数：

bash
docker build --build-arg CLI_VERSION=v1.2.1 . -t michaelin/github-cli