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