mirror of https://gitlab.com/gitlab-org/cli.git
85 lines
2.2 KiB
Markdown
85 lines
2.2 KiB
Markdown
---
|
|
stage: Create
|
|
group: Code Review
|
|
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
|
---
|
|
|
|
# GitLab CLI - `glab`
|
|
|
|
GLab is an open source GitLab CLI tool. It brings GitLab to your terminal:
|
|
next to where you are already working with Git and your code, without
|
|
switching between windows and browser tabs.
|
|
|
|
- Work with issues.
|
|
- Work with merge requests.
|
|
- Watch running pipelines directly from your CLI.
|
|
|
|
|
|
|
|
The GitLab CLI uses commands structured like `glab <command> <subcommand> [flags]`
|
|
to perform many of the actions you normally do from the GitLab user interface:
|
|
|
|
```shell
|
|
# Sign in
|
|
glab auth login --stdin < token.txt
|
|
|
|
# View a list of issues
|
|
glab issue list
|
|
|
|
# Create merge request for issue 123
|
|
glab mr for 123
|
|
|
|
# Check out the branch for merge request 243
|
|
glab mr checkout 243
|
|
|
|
# Watch the pipeline in progress
|
|
glab pipeline ci view
|
|
|
|
# View, approve, and merge the merge request
|
|
glab mr view
|
|
glab mr approve
|
|
glab mr merge
|
|
```
|
|
|
|
## Core commands
|
|
|
|
- [`glab alias`](alias)
|
|
- [`glab api`](api)
|
|
- [`glab auth`](auth)
|
|
- [`glab check-update`](check-update)
|
|
- [`glab ci`](ci)
|
|
- [`glab completion`](completion)
|
|
- [`glab config`](config)
|
|
- [`glab incident`](incident)
|
|
- [`glab issue`](issue)
|
|
- [`glab label`](label)
|
|
- [`glab mr`](mr)
|
|
- [`glab release`](release)
|
|
- [`glab repo`](repo)
|
|
- [`glab schedule`](schedule)
|
|
- [`glab snippet`](snippet)
|
|
- [`glab ssh-key`](ssh-key)
|
|
- [`glab user`](user)
|
|
- [`glab variable`](variable)
|
|
|
|
## Install the CLI
|
|
|
|
Installation instructions are available in the GLab
|
|
[`README`](https://gitlab.com/gitlab-org/cli/#installation).
|
|
|
|
## Authenticate with GitLab
|
|
|
|
To authenticate with your GitLab account, run `glab auth login`.
|
|
`glab` respects tokens set using `GITLAB_TOKEN`.
|
|
|
|
## Report issues
|
|
|
|
Open an issue in the [`gitlab-org/cli` repository](https://gitlab.com/gitlab-org/cli/issues/new)
|
|
to send us feedback.
|
|
|
|
## Related topics
|
|
|
|
- [Install the CLI](https://gitlab.com/gitlab-org/cli/-/blob/main/README.md#installation)
|
|
- The extension source code is available in the
|
|
[`cli`](https://gitlab.com/gitlab-org/cli/) project.
|