summaryrefslogtreecommitdiff
path: root/doc/man/pkgctl-auth-login.1.asciidoc
blob: eeeec4e28a44d0c52cf691cc53ec390c0275d015 (plain)
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
pkgctl-auth-login(1)
====================

Name
----
pkgctl-auth-login - Authenticate with the GitLab instance

Synopsis
--------
pkgctl auth login [OPTIONS]

Description
-----------

Interactively authenticate with the GitLab instance.

The minimum required scopes for the token are: 'api', 'write_repository'.

The GitLab API token can either be stored in a plaintext file in
'$XDG_CONFIG_HOME/devtools/gitlab.conf', or supplied via the
'DEVTOOLS_GITLAB_TOKEN' environment variable using any command (gpg, vault,
password manager) by declaring a shell alias:

    $ alias pkgctl='DEVTOOLS_GITLAB_TOKEN="$(command to obtain token)" pkgctl'

Options
-------

*-g, --gen-access-token*::
	Open the URL to generate a new personal access token

*-h, --help*::
	Show a help text

See Also
--------

linkman:pkgctl-auth-status[1]

include::include/footer.asciidoc[]