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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
|
.Dd @PACKAGE_DATE@
.Dt GCLI-LABELS 1
.Os @PACKAGE_STRING@
.Sh NAME
.Nm gcli\ labels
.Nd Manage ticket labels in git forges
.Sh SYNOPSIS
.Nm
.Op Fl o Ar owner Fl r Ar repo
.Nm
.Cm create
.Op Fl o Ar owner Fl r Ar repo
.Fl d Ar description
.Fl n Ar name
.Fl c Ar colour
.Nm
.Op Fl o Ar owner Fl r Ar repo
.Fl i Ar name
.Ar actions...
.Sh DESCRIPTION
Use
.Nm
to list, create, edit or delete labels for Pull Requests/Merge
Requests and issues in repositories in various git forges such as
GitHub, GitLab and Gitea. Without any action specified,
.Nm
will list all defined labels in the given or auto-detected repository.
.Sh OPTIONS
.Bl -tag -width indent
.It Fl o , -owner Ar owner
Work in the repository of the given owner. This option can only be
used in combination with
.Fl r .
.It Fl r , -repo Ar repo
Work in the given repository. This option can only be used in
combination with
.Fl o .
.It Fl i , -name Ar name
Execute actions on the label identified by
.Ar name .
.El
.Pp
.Sh SUBCOMMANDS
.Bl -tag -width indent
.It Cm create
Create a new label in the given or auto-detected repository.
.Pp
The following flags must be specified:
.Bl -tag -width indent
.It Fl n , -name Ar name
Set the short name of the label to the given
.Ar name .
.It Fl d , -description Ar description
Set the description of the label to the given
.Ar text .
Note that on GitHub this field may only consist of up to 150
characters.
.It Fl c , -colour Ar code
Set the colour of the label to the given
.Ar code .
.Ar code
is expected to be a 6 digit hexadecimal RGB colour code.
.El
.El
.Sh ACTIONS
When given a specific label with
.Fl i
you can execute one or more of the following actions:
.Bl -tag -width indent
.It Cm status
Print a short summary about the label.
.It Cm name Ar new-name
Change the name of the to the given
.Ar new-name .
.It Cm description Ar new-description
Change the description of the label to
.Ar new-description .
You should wrap the description in quotes in case it contains spaces.
.It Cm colour Ar hexcolour
Change the colour of the label to the six-digit hexadecmial RGB
colour code
.Ar hexcolour .
.It Cm delete
Delete the given label.
.El
.Sh EXAMPLES
Print a list of all labels in the current project:
.Bd -literal -offset indent
$ gcli labels
.Ed
.Pp
Create a new label called
.Sq bug
with a description
.Sq Something is not working as expected
and give it a red colour:
.Bd -literal -offset indent
$ gcli labels create \\
--name bug \\
--description "Something is not working as expected" \\
--colour FF0000
.Ed
.Pp
Delete the label
.Sq foobar
in herrhotzenplotz/gcli and use the configured account
.Sq gitlab :
.Bd -literal -offset indent
$ gcli -a gitlab labels -o herrhotzenplotz -r gcli -i foobar delete
.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
The delete subcommand should ask for confirmation and have a flag to
override this behaviour.
.Pp
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.
|
