GitLab 命令行工具：入门与使用 – wiki大全

作者： /

GitLab 命令行工具：入门与使用

在软件开发的世界中，效率至关重要。GitLab 命令行工具 (CLI)，通常被称为 glab，是一个开源工具，它允许开发者直接从终端与 GitLab 服务进行交互。glab 的出现极大地提高了工作效率，通过命令行快速执行常见的 GitLab 任务，自动化重复操作，并远程管理代码仓库和 CI/CD 流水线，而无需频繁切换浏览器标签页。

本文将详细介绍 glab 的入门指南和常用操作。

什么是 GitLab CLI (glab)?

glab 是 GitLab 官方支持的命令行工具，旨在为用户提供一个无缝、高效的方式来管理其 GitLab 项目。它将 GitLab API 的强大功能带到了你的终端，让你能够通过简单的命令完成诸如创建合并请求、管理议题、运行 CI/CD 流水线等操作。

glab 的优势：

  • 提高效率: 快速执行 GitLab 任务，减少浏览器操作。
  • 自动化: 方便集成到脚本和自动化工作流中。
  • 统一体验: 在终端中管理所有 GitLab 相关活动，保持工作流的连贯性。
  • 灵活性: 支持与 GitLab.com 和自托管的 GitLab 实例交互。

前提条件

在开始使用 glab 之前，请确保你满足以下条件：

  1. GitLab 账户: 拥有一个 GitLab.com 账户或可访问的自托管 GitLab 实例。
  2. 终端/命令行: 能够访问你操作系统上的终端或命令提示符。
  3. 个人访问令牌 (PAT): 从你的 GitLab 账户生成一个个人访问令牌。该令牌至少需要 api 和 write_repository 作用域。你可以在 GitLab 账户的“用户设置”>“访问令牌”中生成。

安装 glab

glab 可以在多种操作系统上安装。以下是一些常见的安装方法：

macOS

使用 Homebrew 安装是最便捷的方式：

bash
brew install glab

Windows

  1. 从 GitLab CLI 发布页面 下载最新的二进制文件。
  2. 将可执行文件添加到系统的 PATH 环境变量中。

  3. 或者，你可以使用 Scoop 包管理器：

    bash
    scoop install glab

Linux

你可以根据你的 Linux 发行版选择不同的安装方式：

  • 使用 curl (通用 Linux):

    bash
    curl -sSL https://gitlab-cli.com/install.sh | sh

  • Snapcraft:

    bash
    sudo snap install --edge glab
    sudo snap connect glab:ssh-keys

  • Debian/Ubuntu:

    bash
    sudo apt install git && sudo dpkg -i glab_*_linux_amd64.deb

  • Fedora/CentOS:

    bash
    sudo yum localinstall glab_*_linux_amd64.rpm

  • Arch Linux:

    bash
    yay -S gitlab-glab # 或使用 pacman: sudo pacman -S gitlab-glab-bin

验证安装

安装完成后，通过检查版本来验证 glab 是否成功安装：

bash
glab --version

如果安装成功，你将看到类似 glab version 1.x.x 的输出。

身份验证

在使用 glab 与 GitLab 交互之前，你需要进行身份验证。使用 glab auth login 命令：

bash
glab auth login

按照交互式提示进行操作：

  1. 如果使用的是 GitLab.com，在提示输入主机时直接按回车键。对于自托管的 GitLab 实例，请输入你的实例 URL（例如：https://gitlab.example.com）。
  2. 在提示时提供你的个人访问令牌。

glab 支持多种身份验证方法，包括 OAuth 和个人访问令牌。配置和凭据默认存储在全局配置文件 ~/.config/glab-cli/config.yml 中。

命令结构和帮助

GitLab CLI 命令遵循结构化格式：glab [command] [subcommand] [options]。

要获取有关可用命令及其用法的详细信息，请使用 help 命令：

  • glab help: 查看核心命令列表。
  • glab [command] --help: 获取特定命令的详细信息（例如：glab issue --help）。

常用 GitLab CLI 命令

以下是一些 glab 的常用命令，助你快速上手：

身份验证

  • glab auth login: 登录 GitLab 实例。
  • glab auth status: 检查当前的身份验证状态。

仓库管理

  • glab repo list: 列出你的仓库。
  • glab repo create <project-name>: 创建一个新项目。
  • glab repo clone <repository-url>: 克隆一个仓库。

CI/CD 流水线管理

  • glab ci list: 列出 CI/CD 流水线。
  • glab pipeline run <project-id>: 触发一个流水线。
  • glab ci view: 在执行过程中监控流水线。
  • glab ci status: 检查流水线、作业和阶段的状态。

议题管理

  • glab issue list: 列出项目中的议题。
  • glab issue create -t "我的议题标题" --label important: 创建一个带有标题和标签的议题。
  • glab issue view <issue-id>: 查看特定议题。

合并请求管理

  • glab mr list: 列出合并请求。
  • glab mr list --assignee=@me: 列出分配给你的合并请求。
  • glab mr list --reviewer=@me: 列出需要你评审的请求。
  • glab mr create -t "我的合并请求标题": 创建一个新的合并请求。
  • glab mr approve <merge-request-id>: 批准一个合并请求。
  • glab mr merge <merge-request-id>: 合并一个合并请求。

其他实用命令

  • glab api <endpoint>: 直接向 GitLab API 发送经过身份验证的请求。
  • glab config set check_update false --global: 停止 CLI 提醒新版本（可选）。

总结

glab CLI 是一个强大的工具，使开发者能够直接从命令行高效地与 GitLab 服务进行交互，从而简化工作流程并促进自动化。通过掌握这些基本的命令和概念，你将能够更有效地管理你的 GitLab 项目，提高开发效率。

滚动至顶部