.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "GITLAB-API-V4 1p"
.TH GITLAB-API-V4 1p "2019-01-28" "perl v5.24.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
gitlab\-api\-v4 \- Command line interface to the GitLab API v4.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&    # Generally:
\&    gitlab\-api\-v4 [<options>] <method> [<arg> ...] [<param>:<value> ...]
\&    
\&    # List all groups:
\&    gitlab\-api\-v4 groups
\&    
\&    # List information about a project:
\&    gitlab\-api\-v4 project <project_id>
\&    
\&    # Create an admin user:
\&    gitlab\-api\-v4 create\-user \e
\&        username:foo \e
\&        password:xxxxxxxx \e
\&        email:user@example.com \e
\&        "name:Foo Smith" \e
\&        admin:1
.Ve
.SH "CONFIGURING"
.IX Header "CONFIGURING"
You may configure this module with environment variables, command line options,
and a configuration file.  To setup the configuration file run:
.PP
.Vb 1
\&    gitlab\-api\-v4 configure
.Ve
.PP
This will ask several interactive questions to help you configure this script.
The information, which may include GitLab authentication tokens, is stored in
\&\f(CW\*(C`~/.gitlab\-api\-v4.json\*(C'\fR.
.PP
Read more at GitLab::API::v4::Config.
.SH "OPTIONS"
.IX Header "OPTIONS"
.SS "url"
.IX Subsection "url"
.Vb 1
\&    \-\-url=<url>
.Ve
.PP
Sets \*(L"url\*(R" in GitLab::API::v4.
.SS "access-token"
.IX Subsection "access-token"
.Vb 1
\&    \-\-access\-token=<token>
.Ve
.PP
Sets \*(L"access_token\*(R" in GitLab::API::v4.
.SS "private-token"
.IX Subsection "private-token"
.Vb 1
\&    \-\-private\-token=<token>
.Ve
.PP
Sets \*(L"private_token\*(R" in GitLab::API::v4.
.SS "retries"
.IX Subsection "retries"
.Vb 1
\&    \-\-retries=<count>
.Ve
.PP
Sets \*(L"retries\*(R" in GitLab::API::v4.
.SS "all"
.IX Subsection "all"
.Vb 2
\&    \-\-all
\&    \-a
.Ve
.PP
Retrieves all results when the results would normally be paged.
See \*(L"all\*(R" in GitLab::API::v4::Paginator for details.
.SS "pretty"
.IX Subsection "pretty"
.Vb 2
\&    \-\-pretty
\&    \-p
.Ve
.PP
Enables the \*(L"pretty\*(R" in \s-1JSON\s0 feature.
.SS "canonical"
.IX Subsection "canonical"
.Vb 2
\&    \-\-canonical
\&    \-c
.Ve
.PP
Enables the \*(L"canonical\*(R" in \s-1JSON\s0 feature.
.SH "API METHOD"
.IX Header "API METHOD"
.Vb 1
\&    <method>
.Ve
.PP
The \s-1API\s0 method to call \- one of the methods documented in
\&\*(L"\s-1API METHODS\*(R"\s0 in GitLab::API::v4.
.SH "API ARGUMENTS"
.IX Header "API ARGUMENTS"
.Vb 1
\&    <arg> ...
.Ve
.PP
Any arguments that the \*(L"\s-1API METHOD\*(R"\s0 requires.
.SH "API PARAMETERS"
.IX Header "API PARAMETERS"
.Vb 1
\&    <param>:<value> ...
.Ve
.PP
Any parameters that the \*(L"\s-1API METHOD\*(R"\s0 accepts.
.SS "access-level"
.IX Subsection "access-level"
.Vb 5
\&    access\-level:guest
\&    access\-level:reporter
\&    access\-level:developer
\&    access\-level:master
\&    access\-level:owner
.Ve
.PP
There are mappings setup for the various \f(CW\*(C`access\-level\*(C'\fR parameters
so that you can, for example, specify \f(CW\*(C`access\-level:guest\*(C'\fR and it
will be automatically converted to \f(CW\*(C`access\-level:10\*(C'\fR.
.SH "AUTHORS"
.IX Header "AUTHORS"
See \*(L"\s-1AUTHOR\*(R"\s0 in GitLab::API::v4 and \*(L"\s-1CONTRIBUTORS\*(R"\s0 in GitLab::API::v4.
.SH "LICENSE"
.IX Header "LICENSE"
This script is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.