---
name: "gcli-api"
section: "1"
platform: "linux"
package: "gcli"
version: "2.3.0-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/gcli-api"
---

# gcli-api(1)

Perform API Calls to Git Forges and retrieve results

## NAME

**gcli** **api** – Perform API Calls to Git Forges and retrieve results

## SYNOPSIS

**gcli** \[**-a**\] *path*

## DESCRIPTION

The **gcli** is used to debug API calls. It will autodetect the current forge and perform a request to its REST API. The response is printed to stdout. The API base URL is automatically prepended to the given *path*.

## OPTIONS

- **-a**, **--all**

  Fetch all pages of data (follow the pagination link).

## EXAMPLES

Fetch all pages of data from the issues endpoint of the gcli project. Dump the data into /tmp/foo and be verbose. This will print the queries that are performed to stderr:

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

## SEE ALSO

[git(1)](/git/1.md), [gcli(1)](/gcli/1.md)

## AUTHORS

Nico Sonack aka. herrhotzenplotz ⟨*nsonack@herrhotzenplotz.de*⟩ and contributors.

## BUGS

Please report bugs via E-Mail to *~herrhotzenplotz/gcli-discuss@lists.sr.ht*.

Alternatively you can report them on any of the forges linked at **https://herrhotzenplotz.de/gcli**. However, the preferred and quickest method is to use the mailing list.
