File: 03-Find-Documentation.md

package info (click to toggle)
gcli 2.3.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, trixie
  • size: 2,096 kB
  • sloc: ansic: 19,013; makefile: 312; yacc: 261; sh: 142; lex: 53
file content (69 lines) | stat: -rw-r--r-- 2,450 bytes parent folder | download | duplicates (3)
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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
# How to find documentation

When using gcli one may not always remember all the options and flags
for every subcommand. gcli has lots of integrated help to guide you
through its commands.

## Subcommand help

You can list all available options for the issues subcommand by doing:

    $ gcli issues --help

With your current knowledge you can also explore the `gcli pulls` subcommand.

## General usage

Run the following command:

    $ gcli --help
    usage: gcli [options] subcommand

    OPTIONS:
      -a account     Use the configured account instead of inferring it
      -r remote      Infer account from the given git remote
      -t type        Force the account type:
                        - github (default: github.com)
                        - gitlab (default: gitlab.com)
                        - gitea (default: codeberg.org)
      -c             Force colour and text formatting.
      -q             Be quiet. (Not implemented yet)

      -v             Be verbose.

    SUBCOMMANDS:
      ci             Github CI status info
      comment        Comment under issues and PRs
      config         Configure forges
      forks          Create, delete and list repository forks
      gists          Create, fetch and list Github Gists
      issues         Manage issues
      labels         Manage issue and PR labels
      milestones     Milestone handling
      pipelines      Gitlab CI management
      pulls          Create, view and manage PRs
      releases       Manage releases of repositories
      repos          Remote Repository management
      snippets       Fetch and list Gitlab snippets
      status         General user status and notifications
      api            Fetch plain JSON info from an API (for debugging purposes)
      version        Print version

    gcli 1.2.0 (amd64-unknown-freebsd13.2)
    Using libcurl/8.1.2 OpenSSL/1.1.1t zlib/1.2.13 libpsl/0.21.2 (+libidn2/2.3.4) libssh2/1.11.0 nghttp2/1.53.0
    Using vendored pdjson library
    Report bugs at https://gitlab.com/herrhotzenplotz/gcli/.
    Copyright 2021, 2022, 2023 Nico Sonack <nsonack@herrhotzenplotz.de> and contributors.


This gives you an overview over all the available subcommands. Each
subcommand in turn allows you to get its usage by supplying the
`--help` option to it.

## Manual pages

Furthermore I recommend reading into the manual page `gcli-issues(1)`
and `gcli-pulls(1)`:

    $ man gcli-issues
    $ man gcli-pulls