File: gcli-milestones.1.in

package info (click to toggle)
gcli 2.11.0-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 2,652 kB
  • sloc: ansic: 27,086; sh: 678; makefile: 545; perl: 392; yacc: 261; lex: 60
file content (95 lines) | stat: -rw-r--r-- 2,346 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
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
.Dd @PACKAGE_DATE@
.Dt GCLI-MILESTONES 1
.Os @PACKAGE_STRING@
.Sh NAME
.Nm gcli\ milestones
.Nd List and manage milestones in various Git Forges
.Sh SYNOPSIS
.Nm
.Op Fl o Ar owner Fl r Ar repo
.Nm
.Op Fl o Ar owner Fl r Ar repo
.Op Fl i Ar id
.Nm
.Cm create
.Op Fl o Ar owner Fl r Ar repo
.Fl t Ar title
.Op Fl d Ar description
.Sh DESCRIPTION
The
.Nm
command can be used to work with milestones on various
.Xr git 1
forges. You can list, create, modify or delete milestones.
.Sh OPTIONS
.Bl -tag -width indent
.It Fl i , -id Ar id
Operate on a milestone with the given
.Ar id .
.It Fl o , -owner Ar owner
Work with milestones on a repository of the given
.Ar owner .
.It Fl r , -repo Ar repo
Work with milestones on the given
.Ar repository .
.It Fl t , -title Ar title
Create a milestone with the given
.Ar title .
This option is mandatory when creating a milestone.
.It Fl d , -description Ar description
Create the milestone with the given
.Ar description .
.El
.Sh ACTIONS
When operating on a single milestone you may use one or more of the
following actions:
.Bl -tag -width indent
.It Cm all
Print both general status info and a list of issues related to the
given milestone.
.It Cm status
Print general metadata and information about the milestone.
.It Cm issues
Print a list of issues attached to the milestone.
.It Cm delete
Delete this milestone.
.It Cm open
Open this milestone in a web browser.
.El
.Sh EXAMPLES
Print a list of milestones for the current auto-detected forge:
.Bd -literal -offset indent
$ gcli milestones
.Ed
.Pp
Print details about the milestone with the ID 42:
.Bd -literal -offset indent
$ gcli milestones -i 42 status
.Ed
.Pp
Create a new milestone with the title foobar:
.Bd -literal -offset indent
$ gcli milestones create -t foobar
.Ed
.Pp
Delete milestone number 420 in vim/vim on GitHub:
.Bd -literal -offset indent
$ gcli -t github milestones -i 420 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 deletes the milestone without asking for
confirmation.
.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.