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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
|
<!DOCTYPE html>
<html>
<head>
<title>GCLI Tutorial | How to find documentation</title>
<meta http-equiv="Content-Type" content="text/html;charset=utf-8"/>
<link rel="prev" href="02-First-Steps.html" />
<link rel="next" href="{{NEXTURL}}" />
<!-- Shamelessly stolen from: http://bettermotherfuckingwebsite.com/ -->
<style>
body {
margin:5% auto;
background: #f2f2f2;
color: #444444;
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Helvetica, Arial, sans-serif;
font-size: 16px;
line-height: 1.8;
text-shadow: 0 1px 0 #ffffff; max-width: 73%;
}
pre {
line-height: 1.0;
}
a {
border-bottom: 1px solid #444444;
color: #444444;
text-decoration: none;
}
a:hover {
border-bottom: 0;
}
</style>
</head>
<body>
<nav style=text-align:right>
<a href="02-First-Steps.html" title="First Steps">⇐ Previous</a>
<a href="index.html">Table of contents</a>
<a href="04-Account-Setup.html" title="Setting up an account">Next ⇒</a>
</nav>
<hr />
<h1>How to find documentation</h1>
<p>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.</p>
<h2>Subcommand help</h2>
<p>You can list all available options for the issues subcommand by doing:</p>
<pre><code>$ gcli issues --help
</code></pre>
<p>With your current knowledge you can also explore the <code>gcli pulls</code> subcommand.</p>
<h2>General usage</h2>
<p>Run the following command:</p>
<pre><code>$ 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.
</code></pre>
<p>This gives you an overview over all the available subcommands. Each
subcommand in turn allows you to get its usage by supplying the
<code>--help</code> option to it.</p>
<h2>Manual pages</h2>
<p>Furthermore I recommend reading into the manual page <code>gcli-issues(1)</code>
and <code>gcli-pulls(1)</code>:</p>
<pre><code>$ man gcli-issues
$ man gcli-pulls
</code></pre>
<br />
<hr />
<nav style=text-align:right>
<a href="02-First-Steps.html" title="First Steps">⇐ Previous</a>
<a href="index.html">Table of contents</a>
<a href="04-Account-Setup.html" title="Setting up an account">Next ⇒</a>
</nav>
</body>
</html>
|
