GCLI-API(1)

πŸ“¦
version 2.13.0 Β· 5 versions
, in nixpkgs unstable, ubuntu stonking

πŸ’… GCLI-API(1) β€” bestie's guide to the gcli api command

okay so this is a page from the General Commands Manual, and it's all about gcli api β€” the little command that goes and talks to git forges for you. she's giving debug tool, she's giving API whisperer, and honestly? iconic. ✨


🌸 NAME 🌸

gcli api β€” Perform API Calls to Git Forges and retrieve results

no cap, that's literally her whole job description.


πŸ¦‹ SYNOPSIS πŸ¦‹

gcli api [-a] path

that's it. that's the whole vibe. one optional flag, one path, slay. πŸ’–


πŸ‘‘ DESCRIPTION πŸ‘‘

so bestie, gcli api is the tool you reach for when you wanna debug API calls. fr fr.

Here's the tea: she'll auto-detect the current forge and then go perform a request to that forge's REST API. The response? Printed straight to stdout, as it should be. πŸ’…

and the best part β€” the API base URL is automatically prepended to the path you hand her. so you don't gotta type out the whole URL like some sort of Victorian peasant. you just give her path and she handles the rest. main character energy honestly.


✨ OPTIONS ✨

  • -a, --all β€” Fetch all pages of data (she follows the pagination link). 🧚 this is the "gimme everything, I'm not doing this by hand" button. use it when your results span multiple pages and you want the whole collection, not just page one.

πŸ“ EXAMPLES πŸ“

Here's a real one. We're fetching all pages of data from the issues endpoint of the gcli project, dumping the data into /tmp/foo, and being verbose about it. Being verbose makes her print the queries that are performed to stderr (so your actual data on stdout stays clean, as she intended 😌):

$ gcli -v api -a /projects/herrhotzenplotz%2Fgcli/issues >/tmp/foo

note the %2F in there β€” that's a URL-encoded slash, she's not playing around with path escaping. keep it exactly like that. πŸŽ€


🌈 SEE ALSO 🌈

go read those too, they're part of the family πŸ’œ


🫢 AUTHORS 🫢

Nico Sonack aka. herrhotzenplotz <nsonack@herrhotzenplotz.de> and contributors.

(and the contributors, can't forget the contributors, we love the contributors πŸ’–)


πŸ’€ BUGS πŸ’€

okay so if you find a bug β€” and listen, it happens to the best of us β€” please report it via E-Mail to:

https://lists.sr.ht/~herrhotzenplotz/gcli-discuss

Alternatively, you can report them on any of the forges linked at:

https://sr.ht/~herrhotzenplotz/gcli
however!! the preferred and quickest method is to use the mailing list. so like… do that one first bestie. it's faster, I promise. πŸ™ˆ

πŸŽ€ cute sign-off πŸŽ€

this lil page came to you courtesy of gcli 2.13.0, dated 05-Aug-2026. go forth and query responsibly, bestie βœ¨πŸ’…πŸ‘‘

πŸ“¦ where this page comes from