gitlab-api-v4 man page
gitlab-api-v4 — Command line interface to the GitLab API v4. You may configure this module with environment variables, command line options, and a configuration file. To setup the configuration file run: This will ask several interactive questions to help you configure this script. The information, which may include GitLab authentication tokens, is stored in Read more at GitLab::API::v4::Config. Sets “url” in GitLab::API::v4. Sets “access_token” in GitLab::API::v4. Sets “private_token” in GitLab::API::v4. Sets “retries” in GitLab::API::v4. Retrieves all results when the results would normally be paged. See “all” in GitLab::API::v4::Paginator for details. Enables the “pretty” in JSON feature. Enables the “canonical” in JSON feature. The API method to call - one of the methods documented in “API METHODS” in GitLab::API::v4. Any arguments that the “API Method” requires. Any parameters that the “API Method” accepts. There are mappings setup for the various See “SUPPORT” in GitLab::API::v4. See “AUTHORS” in GitLab::API::v4. See “COPYRIGHT AND LICENSE” in GitLab::API::v4.Synopsis
# 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 \
username:foo \
password:xxxxxxxx \
email:user@example.com \
"name:Foo Smith" \
admin:1
Configuring
gitlab-api-v4 configure
~/.gitlab-api-v4.json
.Options
url
--url=<url>
access-token
--access-token=<token>
private-token
--private-token=<token>
retries
--retries=<count>
all
--all
-a
pretty
--pretty
-p
canonical
--canonical
-c
API Method
<method>
API Arguments
<arg> ...
API Parameters
<param>:<value> ...
access-level
access-level:guest
access-level:reporter
access-level:developer
access-level:master
access-level:owner
access-level
parameters so that you can, for example, specify access-level:guest
and it will be automatically converted to access-level:10
.Support
Authors
Copyright and License
Info