NAME

gitlab-api-v3 - Command line interface to the GitLab API v3.

SYNOPSIS

    # Generally:
    gitlab-api-v3 <method> [<arg> ...] [--<param>=<value> ...]
    
    # List all groups:
    gitlab-api-v3 groups
    
    # List information about a project:
    gitlab-api-v3 project <project_id>
    
    # Create an admin user:
    gitlab-api-v3 create_user \
        --email=<email> --password=<password> --username=<username> --name=<name> --admin

ARGUMENTS

url

    --url=<url>

The URL to to your GitLab API v3 API base. Typically this will be something like http://git.example.com/api/v3.

You can alternatively set this by specifying the GITLAB_API_V3_URL environment variable.

token

    --token=<token>

The API token to access the API with.

Alternatively you can set the GITLAB_API_V3_TOKEN environment variable.

WARNING: As a general rule it is highly discouraged to put sensitive information into command arguments such as your private API token since arguments can be seen by other users of the system. Please use the environment variable if possible.

all

    --all

Retrieves all results when the results would normally be paged.

format

    --format=<format>
    --format=YAML
    --format=JSON
    --format=XML::Simple

Specify the output format used when returning the result of an API call. Accepts any serializer that Data::Serializer supports. Defaults to YAML.

method

    <method>

The API method to call (one of the methods documented in GitLab::API::v3).

args

    <arg> ...

Any arguments that the "method" requires.

params

    --<param>=<value> ...

Any parameters that the "method" accepts.

visibility level

    --visibility-level-private
    --visibility-level-internal
    --visibility-level-public

access level

    --access-level-guest
    --access-level-reporter
    --access-level-developer
    --access-level-master
    --access-level-owner

help

    help
    --help

Displays this handy documentation.

SEE ALSO

GitLab::API::v3.

AUTHOR

Aran Clary Deltac <bluefeet@gmail.com>

LICENSE

This script is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

cpanm GitLab::API::v3

perl -MCPAN -e shell
install GitLab::API::v3