GITLAB-API-V4(1)

📦
version 0.27 · 5 versions
, in epel 9

💖 NAME 💖

okay so bestie, this is gitlab-api-v4(1) — literally the command line interface to the GitLab API v4. It’s giving “make API calls from your terminal without crying,” and honestly? Iconic. 💅

✨ SYNOPSIS ✨

Here’s the whole vibe:

# 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 🎀

You may configure this module with environment variables, command line options, and a configuration file. Three little paths, pick your fighter. To setup the configuration file run:

gitlab-api-v4 configure

This will ask several interactive questions to help you configure this script. The information — which may include GitLab authentication tokens — is stored in ~/.gitlab-api-v4.json. Read more at GitLab::API::v4::Config.

🔥 OPTIONS 🔥

  • --url=<url> — sets url in GitLab::API::v4.
  • --access-token=<token> — sets access_token in GitLab::API::v4.
  • --private-token=<token> — sets private_token in GitLab::API::v4.
  • --retries=<count> — sets retries in GitLab::API::v4.
  • --all, -a — retrieves all results when the results would normally be paged. See all in GitLab::API::v4::Paginator for details.
  • --pretty, -p — enables the pretty feature in JSON::PP.
  • --canonical, -c — enables the canonical feature in JSON::PP.

🦋 API METHOD 🦋

  • <method> — the API method to call, one of the methods documented in "API METHODS" in GitLab::API::v4.

🌈 API ARGUMENTS 🌈

  • <arg> ... — any arguments that the API METHOD requires.

🍓 API PARAMETERS 🍓

  • <param>:<value> ... — any parameters that the API METHOD accepts.

🌸 access-level 🌸

There are mappings set up for the various access-level parameters so that, for example, you can specify access-level:guest and it will be automatically converted to access-level:10.

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

💜 SUPPORT 💜

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

👑 AUTHORS 👑

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

See "COPYRIGHT AND LICENSE" in GitLab::API::v4.

That’s the whole vibe, bestie. Shoutout to the source, User Contributed Perl Documentation, version perl v5.32.1, dated 2025-01-18, and yes — it’s GITLAB-API-V4(1) to the very end. Periodt. 💖✨

📦 where this page comes from