1.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" ""
2.nh
3.ad l
4
5
6.SH NAME
7.PP
8git\-bug\-bridge\-configure \- Configure a new bridge.
9
10
11.SH SYNOPSIS
12.PP
13\fBgit\-bug bridge configure [flags]\fP
14
15
16.SH DESCRIPTION
17.PP
18.RS
19
20.nf
21Configure a new bridge by passing flags or/and using interactive terminal prompts. You can avoid all the terminal prompts by passing all the necessary flags to configure your bridge.
22Repository configuration can be made by passing either the \-\-url flag or the \-\-project and \-\-owner flags. If the three flags are provided git\-bug will use \-\-project and \-\-owner flags.
23Token configuration can be directly passed with the \-\-token flag or in the terminal prompt. If you don't already have one you can use the interactive procedure to generate one.
24
25.fi
26.RE
27
28
29.SH OPTIONS
30.PP
31\fB\-n\fP, \fB\-\-name\fP=""
32 A distinctive name to identify the bridge
33
34.PP
35\fB\-t\fP, \fB\-\-target\fP=""
36 The target of the bridge. Valid values are [github,gitlab,launchpad\-preview]
37
38.PP
39\fB\-u\fP, \fB\-\-url\fP=""
40 The URL of the target repository
41
42.PP
43\fB\-o\fP, \fB\-\-owner\fP=""
44 The owner of the target repository
45
46.PP
47\fB\-c\fP, \fB\-\-credential\fP=""
48 The identifier or prefix of an already known credential for the API (see "git\-bug bridge auth")
49
50.PP
51\fB\-\-token\fP=""
52 A raw authentication token for the API
53
54.PP
55\fB\-\-token\-stdin\fP[=false]
56 Will read the token from stdin and ignore \-\-token
57
58.PP
59\fB\-p\fP, \fB\-\-project\fP=""
60 The name of the target repository
61
62.PP
63\fB\-h\fP, \fB\-\-help\fP[=false]
64 help for configure
65
66
67.SH EXAMPLE
68.PP
69.RS
70
71.nf
72# Interactive example
73[1]: github
74[2]: launchpad\-preview
75target: 1
76name [default]: default
77
78Detected projects:
79[1]: github.com/a\-hilaly/git\-bug
80[2]: github.com/MichaelMure/git\-bug
81
82[0]: Another project
83
84Select option: 1
85
86[1]: user provided token
87[2]: interactive token creation
88Select option: 1
89
90You can generate a new token by visiting https://github.com/settings/tokens.
91Choose 'Generate new token' and set the necessary access scope for your repository.
92
93The access scope depend on the type of repository.
94Public:
95 \- 'public\_repo': to be able to read public repositories
96Private:
97 \- 'repo' : to be able to read private repositories
98
99Enter token: 87cf5c03b64029f18ea5f9ca5679daa08ccbd700
100Successfully configured bridge: default
101
102# For GitHub
103git bug bridge configure \\
104 \-\-name=default \\
105 \-\-target=github \\
106 \-\-owner=$(OWNER) \\
107 \-\-project=$(PROJECT) \\
108 \-\-token=$(TOKEN)
109
110# For Launchpad
111git bug bridge configure \\
112 \-\-name=default \\
113 \-\-target=launchpad\-preview \\
114 \-\-url=https://bugs.launchpad.net/ubuntu/
115
116# For Gitlab
117git bug bridge configure \\
118 \-\-name=default \\
119 \-\-target=github \\
120 \-\-url=https://github.com/michaelmure/git\-bug \\
121 \-\-token=$(TOKEN)
122
123.fi
124.RE
125
126
127.SH SEE ALSO
128.PP
129\fBgit\-bug\-bridge(1)\fP