git-bug-bridge-configure.1

  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\-T\fP, \fB\-\-token\fP=""
 48    The authentication token for the API
 49
 50.PP
 51\fB\-\-token\-stdin\fP[=false]
 52    Will read the token from stdin and ignore \-\-token
 53
 54.PP
 55\fB\-p\fP, \fB\-\-project\fP=""
 56    The name of the target repository
 57
 58.PP
 59\fB\-h\fP, \fB\-\-help\fP[=false]
 60    help for configure
 61
 62
 63.SH EXAMPLE
 64.PP
 65.RS
 66
 67.nf
 68# Interactive example
 69[1]: github
 70[2]: launchpad\-preview
 71target: 1
 72name [default]: default
 73
 74Detected projects:
 75[1]: github.com/a\-hilaly/git\-bug
 76[2]: github.com/MichaelMure/git\-bug
 77
 78[0]: Another project
 79
 80Select option: 1
 81
 82[1]: user provided token
 83[2]: interactive token creation
 84Select option: 1
 85
 86You can generate a new token by visiting https://github.com/settings/tokens.
 87Choose 'Generate new token' and set the necessary access scope for your repository.
 88
 89The access scope depend on the type of repository.
 90Public:
 91	\- 'public\_repo': to be able to read public repositories
 92Private:
 93	\- 'repo'       : to be able to read private repositories
 94
 95Enter token: 87cf5c03b64029f18ea5f9ca5679daa08ccbd700
 96Successfully configured bridge: default
 97
 98# For GitHub
 99git bug bridge configure \\
100    \-\-name=default \\
101    \-\-target=github \\
102    \-\-owner=$(OWNER) \\
103    \-\-project=$(PROJECT) \\
104    \-\-token=$(TOKEN)
105
106# For Launchpad
107git bug bridge configure \\
108    \-\-name=default \\
109    \-\-target=launchpad\-preview \\
110	\-\-url=https://bugs.launchpad.net/ubuntu/
111
112# For Gitlab
113git bug bridge configure \\
114    \-\-name=default \\
115    \-\-target=github \\
116    \-\-url=https://github.com/michaelmure/git\-bug \\
117    \-\-token=$(TOKEN)
118
119.fi
120.RE
121
122
123.SH SEE ALSO
124.PP
125\fBgit\-bug\-bridge(1)\fP