path: root/doc/man/git-bug-bridge-configure.1

.nh
.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" ""

.SH NAME
.PP
git-bug-bridge-configure - Configure a new bridge.


.SH SYNOPSIS
.PP
\fBgit-bug bridge configure [flags]\fP


.SH DESCRIPTION
.PP
.RS

.nf
Configure 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.

.fi
.RE


.SH OPTIONS
.PP
\fB-n\fP, \fB--name\fP=""
	A distinctive name to identify the bridge

.PP
\fB-t\fP, \fB--target\fP=""
	The target of the bridge. Valid values are [github,gitlab,jira,launchpad-preview]

.PP
\fB-u\fP, \fB--url\fP=""
	The URL of the remote repository

.PP
\fB-b\fP, \fB--base-url\fP=""
	The base URL of your remote issue tracker

.PP
\fB-l\fP, \fB--login\fP=""
	The login on your remote issue tracker

.PP
\fB-c\fP, \fB--credential\fP=""
	The identifier or prefix of an already known credential for your remote issue tracker (see "git-bug bridge auth")

.PP
\fB--token\fP=""
	A raw authentication token for the remote issue tracker

.PP
\fB--token-stdin\fP[=false]
	Will read the token from stdin and ignore --token

.PP
\fB-o\fP, \fB--owner\fP=""
	The owner of the remote repository

.PP
\fB-p\fP, \fB--project\fP=""
	The name of the remote repository

.PP
\fB--non-interactive\fP[=false]
	Do not ask for user input

.PP
\fB-h\fP, \fB--help\fP[=false]
	help for configure


.SH EXAMPLE
.PP
.RS

.nf
# Interactive example
[1]: github
[2]: gitlab
[3]: jira
[4]: launchpad-preview

target: 1
name [default]: default

Detected projects:
[1]: github.com/a-hilaly/git-bug
[2]: github.com/MichaelMure/git-bug

[0]: Another project

Select option: 1

[1]: user provided token
[2]: interactive token creation
Select option: 1

You can generate a new token by visiting https://github.com/settings/tokens.
Choose 'Generate new token' and set the necessary access scope for your repository.

The access scope depend on the type of repository.
Public:
	- 'public_repo': to be able to read public repositories
Private:
	- 'repo'       : to be able to read private repositories

Enter token: 87cf5c03b64029f18ea5f9ca5679daa08ccbd700
Successfully configured bridge: default

# For GitHub
git bug bridge configure \\
    --name=default \\
    --target=github \\
    --owner=$(OWNER) \\
    --project=$(PROJECT) \\
    --token=$(TOKEN)

# For Launchpad
git bug bridge configure \\
    --name=default \\
    --target=launchpad-preview \\
	--url=https://bugs.launchpad.net/ubuntu/

# For Gitlab
git bug bridge configure \\
    --name=default \\
    --target=github \\
    --url=https://github.com/michaelmure/git-bug \\
    --token=$(TOKEN)

.fi
.RE


.SH SEE ALSO
.PP
\fBgit-bug-bridge(1)\fP