File: gcli-api.1.in

package info (click to toggle)
gcli 2.3.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,096 kB
  • sloc: ansic: 19,013; makefile: 312; yacc: 261; sh: 142; lex: 53
file content (43 lines) | stat: -rw-r--r-- 1,162 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
.Dd @PACKAGE_DATE@
.Dt GCLI-API 1
.Os @PACKAGE_STRING@
.Sh NAME
.Nm gcli api
.Nd Perform API Calls to Git Forges and retrieve results
.Sh SYNOPSIS
.Nm
.Op Fl a
.Ar path
.Sh DESCRIPTION
The
.Nm
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
.Ar path .
.Sh OPTIONS
.Bl -tag -width "-a, --all"
.It Fl a , -all
Fetch all pages of data (follow the pagination link).
.El
.Sh 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:
.Bd -literal -offset indent
$ gcli -v api -a /projects/herrhotzenplotz%2Fgcli/issues >/tmp/foo
.Ed
.Sh SEE ALSO
.Xr git 1 ,
.Xr gcli 1
.Sh AUTHORS
.An Nico Sonack aka. herrhotzenplotz Aq Mt nsonack@herrhotzenplotz.de
and contributors.
.Sh BUGS
Please report bugs via E-Mail to
.Mt @PACKAGE_BUGREPORT@ .
.Pp
Alternatively you can report them on any of the forges linked at
.Lk @PACKAGE_URL@ .
However, the preferred and quickest method is to use the mailing
list.