File: gcli-forks.1.in

package info (click to toggle)
gcli 2.10.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,596 kB
  • sloc: ansic: 26,273; sh: 601; makefile: 538; perl: 374; yacc: 261; lex: 59
file content (104 lines) | stat: -rw-r--r-- 2,646 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
96
97
98
99
100
101
102
103
104
.Dd @PACKAGE_DATE@
.Dt GCLI-FORKS 1
.Os @PACKAGE_STRING@
.Sh NAME
.Nm gcli\ forks
.Nd Manage repository forks in git forges
.Sh SYNOPSIS
.Nm
.Op Fl n Ar n
.Op Fl y
.Op Fl s
.Op Fl o Ar owner Fl r Ar repo
.Ar actions...
.Nm
.Cm create
.Op Fl o Ar owner Fl r Ar repo
.Op Fl i Ar target-owner
.Sh DESCRIPTION
Use
.Nm
to manage forks of other repositories in various
.Xr git 1
forges such as GitHub, GitLab and Gitea.
.Sh OPTIONS
.Bl -tag -width indent
.It Fl o , -owner Ar owner
Operate on the repository of the given owner. This option can only be
used in combination with
.Fl r .
.It Fl r , -repo Ar repo
Operate on the given repository. This option can only be used in
combination with
.Fl o .
.It Fl y , -yes
Do not ask for confirmation. Assume yes.
.It Fl s , -sorted
Reverse the output such that most recent items appear at the bottom.
.It Fl i , -into Ar target-owner
When forking a repository, this is the organisation or user the
repository is forked into.
.It Fl n , -count Ar n
Fetch at least
.Ar n
forks. Setting
.Ar n
to -1 will fetch all forks. Default: 30. Note that on repositories
with many forks fetching all forks can take a considerable amount of
time and may result in rate limiting by the respective API.
.El
.Sh ACTIONS
.Ar actions...
may be one or more of the following:
.Bl -tag -width indent
.It Cm delete
Delete the fork. You will be asked for confirmation unless you set
.Fl y .
.Pp
The following flags can be specified:
.Bl -tag -width indent
.It Fl r , -repo
See
.Sx OPTIONS
.It Fl o , -owner
See
.Sx OPTIONS
.It Fl y , -yes
Do not ask for confirmation before deleting the fork. See
.Sx OPTIONS .
.El
.El
.Sh EXAMPLES
Clone vim/vim and fork it into your account:
.Bd -literal -offset indent
$ git clone git@github.com:vim/vim
$ cd vim
$ gcli forks create --into <myaccount>
.Ed
.Pp
This will ask you if you want to add a remote to your fork. In case
you accept the offer, the origin remote will be renamed to upstream
and a new origin will be pointed at your newly created fork. You may
also want to setup a .gcli file at the same time:
.Bd -literal -offset indent
$ printf -- "pr.upstream=vim/vim\\npr.base=trunk\\n" >> .gcli
.Ed
.Pp
Delete your fork of the current repository without confirmation:
.Bd -literal -offset indent
$ gcli forks -y 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
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.