File: gcli-config.1.in

package info (click to toggle)
gcli 2.9.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,476 kB
  • sloc: ansic: 25,411; sh: 580; makefile: 509; yacc: 261; lex: 59
file content (72 lines) | stat: -rw-r--r-- 1,716 bytes parent folder | download
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
.Dd @PACKAGE_DATE@
.Dt GCLI-ISSUES 1
.Os @PACKAGE_STRING@
.Sh NAME
.Nm gcli\ config
.Nd Git Forge Configuration
.Sh SYNOPSIS
.Nm
.Cm ssh
.Nm
.Cm ssh add
.Fl t Ar title
.Fl k Ar keypath
.Nm
.Cm ssh delete
.Fl i Ar id
.Sh DESCRIPTION
.Nm
is used to change the settings of the Git Forge Account. You can use
it to e.g. add or delete SSH Public Keys used to push to forges.
.Sh OPTIONS
.Bl -tag -width xxxxxxxxxxxxxxxxx
.It Fl t , -title Ar title
Set the title of the SSH Key to be added. This is a short description
of the key.
.It Fl k , -key Pa key-path
Path to the file containing the SSH public key.
.It Fl i , -id Ar id
ID of the public key to delete.
.El
.
.Sh SUBCOMMANDS
.Bl -tag -width xxxxxxxxxxx
.It Cm ssh
List SSH public keys for the current user.
.It Cm ssh add
Add an SSH public key for the current user.
.It Cm ssh delete
Delete an SSH public key for the current user.
.El
.Sh EXAMPLES
Print a list of registered SSH public keys:
.Bd -literal -offset indent
$ gcli config ssh
.Ed
.Pp
Register ~/.ssh/id_rsa.pub on the default forge:
.Bd -literal -offset indent
$ gcli config ssh add \\
      -t "Key for $(hostname)" \\
      -k ~/.ssh/id_rsa.pub
.Ed
.Pp
.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
When using this feature to manage SSH keys on GitHub be aware that you need the
.Dq read:public_key
scope enabled on your access token. You will receive HTTP 404 errors
otherwise.
.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.