1GITLAB-API-V4(1)      User Contributed Perl Documentation     GITLAB-API-V4(1)
2
3
4

NAME

6       gitlab-api-v4 - Command line interface to the GitLab API v4.
7

SYNOPSIS

9           # Generally:
10           gitlab-api-v4 [<options>] <method> [<arg> ...] [<param>:<value> ...]
11
12           # List all groups:
13           gitlab-api-v4 groups
14
15           # List information about a project:
16           gitlab-api-v4 project <project_id>
17
18           # Create an admin user:
19           gitlab-api-v4 create-user \
20               username:foo \
21               password:xxxxxxxx \
22               email:user@example.com \
23               "name:Foo Smith" \
24               admin:1
25

CONFIGURING

27       You may configure this module with environment variables, command line
28       options, and a configuration file.  To setup the configuration file
29       run:
30
31           gitlab-api-v4 configure
32
33       This will ask several interactive questions to help you configure this
34       script.  The information, which may include GitLab authentication
35       tokens, is stored in "~/.gitlab-api-v4.json".
36
37       Read more at GitLab::API::v4::Config.
38

OPTIONS

40   url
41           --url=<url>
42
43       Sets "url" in GitLab::API::v4.
44
45   access-token
46           --access-token=<token>
47
48       Sets "access_token" in GitLab::API::v4.
49
50   private-token
51           --private-token=<token>
52
53       Sets "private_token" in GitLab::API::v4.
54
55   retries
56           --retries=<count>
57
58       Sets "retries" in GitLab::API::v4.
59
60   all
61           --all
62           -a
63
64       Retrieves all results when the results would normally be paged.  See
65       "all" in GitLab::API::v4::Paginator for details.
66
67   pretty
68           --pretty
69           -p
70
71       Enables the "pretty" in JSON::PP feature.
72
73   canonical
74           --canonical
75           -c
76
77       Enables the "canonical" in JSON::PP feature.
78

API METHOD

80           <method>
81
82       The API method to call - one of the methods documented in "API METHODS"
83       in GitLab::API::v4.
84

API ARGUMENTS

86           <arg> ...
87
88       Any arguments that the "API METHOD" requires.
89

API PARAMETERS

91           <param>:<value> ...
92
93       Any parameters that the "API METHOD" accepts.
94
95   access-level
96           access-level:guest
97           access-level:reporter
98           access-level:developer
99           access-level:master
100           access-level:owner
101
102       There are mappings setup for the various "access-level" parameters so
103       that you can, for example, specify "access-level:guest" and it will be
104       automatically converted to "access-level:10".
105

SUPPORT

107       See "SUPPORT" in GitLab::API::v4.
108

AUTHORS

110       See "AUTHORS" in GitLab::API::v4.
111

113       See "COPYRIGHT AND LICENSE" in GitLab::API::v4.
114
115
116
117perl v5.38.0                      2023-07-20                  GITLAB-API-V4(1)
Impressum