极狐 GitLab

极狐GitLab CLI (glab)

Tier: 基础版，专业版，旗舰版

Offering: JihuLab.com，私有化部署

GLab 是一个开源的极狐GitLab CLI 工具。它把极狐GitLab 带到你的终端里，就在你已在使用 git 和代码的地方旁边，让你无需在窗口和浏览器标签页之间切换。虽然它在处理议题和合并请求方面已经很强大了，glab 还能做更多：

  • 直接在 CLI 中查看、管理和重试 CI/CD 流水线。
  • 创建变更日志。
  • 创建和管理发布。
  • 向极狐GitLab Duo Chat（经典版）询问 Git 相关问题。
  • 管理用于 Kubernetes 的极狐GitLab agent。

glab 可用于托管在 JihuLab.com 和私有化部署的仓库。它支持多个经过认证的极狐GitLab 实例，并能自动从当前工作 Git 目录中的远程仓库检测认证主机名。

命令示例

安装 CLI#

安装说明可在 GLab 的 README 中找到。

与极狐GitLab 进行认证#

GLab 支持多种认证方式，包括 OAuth 和个人访问令牌。 要开始使用，请运行 glab auth login 并跟随交互式设置完成。

详细的认证说明，请参阅主 README 中的认证部分。

环境变量#

变量描述
BROWSER用于打开链接的 Web 浏览器。可通过 glab config set browser mybrowser 在配置中设置。
DEBUG设置为 true 可输出更多日志信息，包括底层 Git 命令、展开的别名和 DNS 错误详情。
FORCE_HYPERLINKS设置为 true 可在输出中强制使用超链接，即使并非输出到 TTY 时也如此。
GITLAB_CLIENT_ID提供由极狐GitLab OAuth 2.0 应用程序生成的自定义 client_id。默认为 JihuLab.com 的 client-id。
GITLAB_HOST or GL_HOST如果是私有化部署，指定极狐GitLab 服务器的 URL。（示例：https://gitlab.example.com）默认值为 https://jihulab.com。
GITLAB_TOKEN用于 API 请求的认证令牌。设置此变量可避免认证提示。会覆盖任何之前存储的凭证。可通过 glab config set token xxxxxx 在配置中设置。
GLAB_CHECK_UPDATE设置为 true 可强制进行更新检查。CLI 工具默认每天检查一次更新。
GLAB_CONFIG_DIR设置为目录路径可覆盖全局配置位置。
GLAB_DEBUG_HTTP设置为 true 可输出 HTTP 传输信息（请求 / 响应）。
GLAB_SEND_TELEMETRY设置为 false 可禁止向你的极狐GitLab 实例发送遥测数据。可通过 glab config set telemetry false 在配置中设置。更多信息请参见 https://gitlab.cn/docs/administration/settings/usage_statistics/
GLAMOUR_STYLE用于设置所需 Markdown 渲染器风格的环境变量。可用选项：dark、light、notty。要设置自定义样式，请阅读 https://github.com/charmbracelet/glamour#styles
NO_COLOR设置为任意值可避免打印彩色输出的 ANSI 转义序列。
NO_PROMPT设置为 true 可禁用提示。
REMOTE_ALIAS or GIT_REMOTE_URL_VAR包含极狐GitLab URL 的 git remote 变量或别名。可通过 glab config set remote_alias origin 在配置中设置。
VISUAL, EDITOR (in order of precedence)用于编辑文本的编辑器工具。可通过 glab config set editor vim 在配置中设置。
GLAB_ENABLE_CI_AUTOLOGIN设置为 true 可在极狐GitLab CI 中启用自动登录。CI 自动登录通过检查预定义的 CI/CD 变量 GITLAB_CI 检测 glab 是否在极狐GitLab CI 作业中运行。如果检测到，它会利用 CI_SERVER_FQDN、CI_JOB_TOKEN 等预定义 CI/CD 变量来登录，并忽略 GITLAB_HOST 等主机变量。如果设置了 GITLAB_TOKEN、GITLAB_ACCESS_TOKEN 或 OAUTH_TOKEN，则它们优先于 CI_JOB_TOKEN。只有支持 CI_JOB_TOKEN 的 glab 命令才能在 CI 自动登录下工作。有关支持的命令列表，请参见 https://gitlab.cn/docs/ci/jobs/ci_job_token/#job-token-access。

选项#

plaintext
  -h, --help      显示此命令的帮助信息。
  -v, --version   显示 glab 版本信息。

命令#

报告议题#

在 gitlab-org/cli 仓库中提交议题，向我们发送反馈。