Send patches - preferably formatted by git format-patch - to patches at archlinux32 dot org.
summaryrefslogtreecommitdiff
path: root/doc/man/pkgctl-auth-login.1.asciidoc
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/pkgctl-auth-login.1.asciidoc')
-rw-r--r--doc/man/pkgctl-auth-login.1.asciidoc40
1 files changed, 40 insertions, 0 deletions
diff --git a/doc/man/pkgctl-auth-login.1.asciidoc b/doc/man/pkgctl-auth-login.1.asciidoc
new file mode 100644
index 0000000..eeeec4e
--- /dev/null
+++ b/doc/man/pkgctl-auth-login.1.asciidoc
@@ -0,0 +1,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[]