glab · GitLab

GitLab CLI Agent 使用指南

通过脚本处理 GitLab 合并请求、Issue、流水线和发布。

官方工具操作风险: R0R3verified
Agent 适配度
84/100
证据可信度
verified
文档检查日期
2026-07-10
独立测试版本
1.92.1

为 Agent 安装

选择与运行环境匹配的官方安装方式。在团队或 CI 环境中固定版本,并先运行版本检查。

Homebrew推荐
macos · linux
$ shell
brew install glab
winget
windows
$ shell
winget install GLab.GLab
认证与最小权限
只提供任务需要的权限,凭证通过环境变量或平台密钥存储传入,不能写进提示词、仓库或日志。
需要认证支持无界面认证

在写操作获批前,使用项目级且仅具 read_api 权限的 Token。

认证方式
OAuth, personal access token, CI job token
密钥环境变量
GITLAB_TOKEN, GITLAB_HOST
凭据保存位置
无界面运行时,在进程启动时从 CI 或平台密钥管理器注入 GITLAB_TOKEN、GITLAB_HOST。本地交互使用时,若官方客户端支持,应优先使用 CLI 或操作系统凭据存储;不要把值写入仓库文件。
Agent 与运行环境兼容性
先确认 Agent 能使用 Shell,再检查平台、网络与凭证是否可用。
claude-codecodexgemini-clicopilot-cli
Environments
local, ci, container, headless, remote
Platforms
macos, linux, windows

用于稳定自动化的结构化输出

优先使用机器可读格式,并把 stdout 作为结果、stderr 作为诊断信息分别处理。

json · text
在支持的命令中使用 --output json,并将诊断日志保留在 stderr。
--output json

尚未记录真实输出样例

当前结构化输出能力来自官方文档。完成有限、非破坏性执行并保存 stdout 前,不展示推测样例或伪造 Schema。

R0–R3 命令风险指南

风险按单条命令判断。R0 是本地或远程只读,R1 是可逆的本地写入,R2 会改变远程状态,R3 可能造成不可逆或生产级影响。

只读不等于可公开

R0 只表示命令不更改本地或远程状态。只读命令仍可能返回令牌、身份信息、配置或生产数据;只展示完成任务所需的最少内容,不得写入日志、Prompt 或提交内容。

R0列出合并请求
读取合并请求元数据,用于审查和分流。
$ shell
glab mr list --output json
可重复执行敏感输出
R2更新 Issue
会修改远程 Issue 字段,需要确认。
$ shell
glab issue update 123 --label bug
执行前必须确认可能产生重复变更

Agent Readiness 评分依据

适配度描述 Agent 操作工具的稳定程度,不代表所有命令都安全,也不替代独立执行测试。

文档证据对应的 Agent Readiness 为 84/100;已记录 1.92.1 的有限本地 Smoke Test,使用未测试命令前仍需查看证据边界。

结构化输出
在支持的命令中使用 --output json,并将诊断日志保留在 stderr。
18/20
x
无界面运行
官方文档描述了非交互认证或执行路径。
14/15
x
安全控制
CLI Finder 将读取命令与需要确认的命令分开。
11/15
x
确定性
命令尽量使用显式参数和文档支持的输出控制。
8/10
x
认证
在写操作获批前,使用项目级且仅具 read_api 权限的 Token。
8/10
x
文档
本条目引用了 2026-07-10 检查的官方文档。
9/10
x
安装
官方安装路径覆盖 macOS、Linux 和 Windows。
8/8
x
维护状态
条目链接了官方源码仓库,便于检查发布与维护状态。
6/7
x
Agent 产物
CLI Finder 可生成基于注册表的 Skill 和策略;该分数不假定工具自身提供这些产物。
2/5
x

生成 Skill 或 Agent 策略

选择目标 Agent 和安全模式,生成包含安装、允许命令、确认边界与证据说明的可复制产物。

生成结果预览
SKILL.md
---
name: gitlab-cli-agent-workflow
description: Use GitLab CLI for merge requests, GitLab issues, pipelines with explicit command risk and evidence boundaries.
---

# GitLab CLI agent workflow

Use this skill when the task needs merge requests, GitLab issues, pipelines, releases.

## Evidence boundary

- Registry confidence: `verified`
- Documentation checked: `2026-07-10`
- Locally tested version: `1.92.1`
- Treat only the recorded executed checks as independently verified; every unlisted command remains documentation-only.

## Executed smoke checks

- `glab --version` — passed; exit 0. The recorded smoke check completed successfully.
- `glab --help` — passed; exit 0. The recorded smoke check completed successfully.

## Installation

- Homebrew (macos, linux): `brew install glab`
- winget (windows): `winget install GLab.GLab`

## Authentication

- Methods: OAuth, personal access token, CI job token
- Secret environment variables: `GITLAB_TOKEN`, `GITLAB_HOST`
- Minimum permissions: Use a project-scoped token with read_api until a write is approved.
- Credential storage: For headless runs, inject GITLAB_TOKEN, GITLAB_HOST from the CI or platform secret manager at process start. For local interactive use, prefer the CLI or operating-system credential store when the official client supports one. Never save values in repository files.
- Never print, persist, or commit credential values.

## Allowed commands (read-only)

- `glab mr list --output json` — R0: Reads merge request metadata for review and triage.

## Commands requiring explicit approval (read-only)

- None recorded.

## Forbidden commands (read-only)

- R2 `glab issue update 123 --label bug` — Changes remote issue fields and requires approval.

## Execution rules

1. Mode boundary: R0 exact commands may be used; R1, R2, and R3 commands are forbidden.
2. Confirm the selected account, project, context, database, namespace, or environment before any command.
3. Prefer structured output using `--output json`.
4. Capture the exact command, exit code, stdout, and stderr separately.
5. A generated prefix policy must prompt unless that exact prefix is explicitly marked suffix-safe; do not infer safety from the executable name.
6. Never broaden credentials or disable safety controls to make a command succeed.

## Official sources

- [GitLab CLI documentation](https://docs.gitlab.com/cli/)
- [GitLab CLI documentation source repository](https://gitlab.com/gitlab-org/cli)

这个任务该用 CLI、MCP 还是 API

CLI
适合在开发机、CI 或容器里复用现有 Shell、凭证和脚本,尤其适合短时、可观察的任务。
MCP
当 Agent 需要受控工具定义、委托身份或由服务端集中治理访问时,MCP 可能更合适。
API
当工作流是应用内长期集成、批量调用或事件驱动时,直接 API 往往比启动进程更稳定。
查看 CLI 与 MCP 完整对比

验证记录与官方证据

CLI Finder 分开记录文档检查和真实执行。未执行过的安装、帮助、退出码与输出不能标为 Verified。

当前证据边界
已在本地检查 glab 二进制、版本输出、帮助内容和成功退出码;未执行认证、GitLab 主机访问、合并请求 JSON 输出、写操作或破坏性命令。
证据可信度
verified
独立测试版本
1.92.1 · 2026-07-10
测试环境
macOS 26.5.1 (arm64), local non-interactive shell

真实执行项

  • 通过退出码: 0
    glab --version

    已记录的 Smoke Check 成功完成。

    stdout 摘要

    glab 1.92.1 (fcecef55)
  • 通过退出码: 0
    glab --help

    已记录的 Smoke Check 成功完成。

官方来源
打开官方资料确认当前版本和命令。

替代工具与相关入口

处理代码仓库、拉取请求、Issue、流水线和发布。
使用 GitHub 官方 CLI 审查拉取请求、处理 Issue、检查 Actions 并管理发布。
收集 PR 元数据并在本地检查补丁,先报告 blocker,不自动评论或合并。
用确定性本地工具配合 Codex,只在沙箱和审批规则允许时加入远程 CLI。
本地和 CI 的 shell 工作优先 CLI;更看重 typed discovery 和中介式远程权限时选 MCP。

Agent 使用 GitLab CLI 的常见问题