File: login.md

package info (click to toggle)
glab 1.53.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 20,936 kB
  • sloc: sh: 295; makefile: 153; perl: 99; ruby: 68; javascript: 67
file content (66 lines) | stat: -rw-r--r-- 2,138 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
---
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
---

<!--
This documentation is auto generated by a script.
Please do not edit this file directly. Run `make gen-docs` instead.
-->

# `glab auth login`

Authenticate with a GitLab instance.

## Synopsis

Authenticate with a GitLab instance.
You can pass in a token on standard input by using `--stdin`.
The minimum required scopes for the token are: `api`, `write_repository`.
Configuration and credentials are stored in the global configuration file (Default: `~/.config/glab-cli/config.yml`)

```plaintext
glab auth login [flags]
```

## Examples

```plaintext
# Start interactive setup
$ glab auth login

# Authenticate against `gitlab.com` by reading the token from a file
$ glab auth login --stdin < myaccesstoken.txt

# Authenticate with a self-hosted GitLab instance
$ glab auth login --hostname salsa.debian.org

# Non-interactive setup
$ glab auth login --hostname gitlab.example.org --token glpat-xxx --api-host gitlab.example.org:3443 --api-protocol https --git-protocol ssh

# Non-interactive setup reading token from a file
$ glab auth login --hostname gitlab.example.org --api-host gitlab.example.org:3443 --api-protocol https --git-protocol ssh  --stdin < myaccesstoken.txt
# non-interactive job token setup
$ glab auth login --hostname gitlab.example.org --job-token $CI_JOB_TOKEN

```

## Options

```plaintext
  -a, --api-host string       API host url.
  -p, --api-protocol string   API protocol: https, http
  -g, --git-protocol string   Git protocol: ssh, https, http
  -h, --hostname string       The hostname of the GitLab instance to authenticate with.
  -j, --job-token string      CI job token.
      --stdin                 Read token from standard input.
  -t, --token string          Your GitLab access token.
      --use-keyring           Store token in your operating system's keyring.
```

## Options inherited from parent commands

```plaintext
      --help   Show help for this command.
```