git-bug/doc/man/git-bug-bridge-new.1

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

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


.SH SYNOPSIS
.PP
\fBgit-bug bridge new [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 new


.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 new \\
    --name=default \\
    --target=github \\
    --owner=$(OWNER) \\
    --project=$(PROJECT) \\
    --token=$(TOKEN)

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

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

.fi
.RE


.SH SEE ALSO
.PP
\fBgit-bug-bridge(1)\fP
commands: add the "bridge" and "bridge configure" commands 2018-09-24 16:25:57 +03:00			`.nh`
update gqlgen 2022-02-15 21:57:26 +03:00			`.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" ""`
commands: add the "bridge" and "bridge configure" commands 2018-09-24 16:25:57 +03:00
			`.SH NAME`
			`.PP`
commands: reorg into different packages 2022-09-10 12:09:19 +03:00			`git-bug-bridge-new - Configure a new bridge`
commands: add the "bridge" and "bridge configure" commands 2018-09-24 16:25:57 +03:00

			`.SH SYNOPSIS`
			`.PP`
commands: reorg into different packages 2022-09-10 12:09:19 +03:00			`\fBgit-bug bridge new [flags]\fP`
commands: add the "bridge" and "bridge configure" commands 2018-09-24 16:25:57 +03:00

			`.SH DESCRIPTION`
			`.PP`
Update man pages and bash_completion 2019-05-29 21:50:30 +03:00			`.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`
commands: add the "bridge" and "bridge configure" commands 2018-09-24 16:25:57 +03:00

			`.SH OPTIONS`
Update man pages and bash_completion 2019-05-29 21:50:30 +03:00			`.PP`
update gqlgen 2022-02-15 21:57:26 +03:00			`\fB-n\fP, \fB--name\fP=""`
update auto-generated files 2020-02-23 16:38:02 +03:00			`A distinctive name to identify the bridge`
Update man pages and bash_completion 2019-05-29 21:50:30 +03:00
			`.PP`
update gqlgen 2022-02-15 21:57:26 +03:00			`\fB-t\fP, \fB--target\fP=""`
			`The target of the bridge. Valid values are [github,gitlab,jira,launchpad-preview]`
Update man pages and bash_completion 2019-05-29 21:50:30 +03:00
			`.PP`
update gqlgen 2022-02-15 21:57:26 +03:00			`\fB-u\fP, \fB--url\fP=""`
update auto-generated files 2020-02-23 16:38:02 +03:00			`The URL of the remote repository`
Update man pages and bash_completion 2019-05-29 21:50:30 +03:00
bridge/gitlab: support self-hosted GitLab instance 2019-12-10 22:30:29 +03:00			`.PP`
update gqlgen 2022-02-15 21:57:26 +03:00			`\fB-b\fP, \fB--base-url\fP=""`
update auto-generated files 2020-02-23 16:38:02 +03:00			`The base URL of your remote issue tracker`
bridge/gitlab: support self-hosted GitLab instance 2019-12-10 22:30:29 +03:00
Update man pages and bash_completion 2019-05-29 21:50:30 +03:00			`.PP`
update gqlgen 2022-02-15 21:57:26 +03:00			`\fB-l\fP, \fB--login\fP=""`
update auto-generated files 2020-02-23 16:38:02 +03:00			`The login on your remote issue tracker`
Update man pages and bash_completion 2019-05-29 21:50:30 +03:00
			`.PP`
update gqlgen 2022-02-15 21:57:26 +03:00			`\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")`
Update man pages and bash_completion 2019-05-29 21:50:30 +03:00
github: tiny cleanups of the configurator 2019-11-26 21:46:50 +03:00			`.PP`
update gqlgen 2022-02-15 21:57:26 +03:00			`\fB--token\fP=""`
update auto-generated files 2020-02-23 16:38:02 +03:00			`A raw authentication token for the remote issue tracker`
github: tiny cleanups of the configurator 2019-11-26 21:46:50 +03:00
commands: add bridge configure completion scripts 2019-08-24 14:11:58 +03:00			`.PP`
update gqlgen 2022-02-15 21:57:26 +03:00			`\fB--token-stdin\fP[=false]`
			`Will read the token from stdin and ignore --token`
commands: add bridge configure completion scripts 2019-08-24 14:11:58 +03:00
bridges: massive refactor - automatic flag validation and warning - generalized prompt - cleanups 2020-02-15 04:55:19 +03:00			`.PP`
update gqlgen 2022-02-15 21:57:26 +03:00			`\fB-o\fP, \fB--owner\fP=""`
update auto-generated files 2020-02-23 16:38:02 +03:00			`The owner of the remote repository`
bridges: massive refactor - automatic flag validation and warning - generalized prompt - cleanups 2020-02-15 04:55:19 +03:00
Update man pages and bash_completion 2019-05-29 21:50:30 +03:00			`.PP`
update gqlgen 2022-02-15 21:57:26 +03:00			`\fB-p\fP, \fB--project\fP=""`
update auto-generated files 2020-02-23 16:38:02 +03:00			`The name of the remote repository`
Update man pages and bash_completion 2019-05-29 21:50:30 +03:00
CLI: Add non-interactive option to interactive commands (#651) * Add option to skip the AvatarURL input request Using an empty string for the avatar cli flag e.g. `git-bug user create -a ""` will still result in a prompt. As the avatar URL is an optional option, it should be possible to skip asking for it entirely. Otherwise automated user creation via a script must make use of pipe hacks. * Add global --non-interactive cmdline option * Replace --skipAvatar for --non-interactive option * Cmd BugAdd: respect non-interactive option * Cmd bridge configure: respect non-interactive opt * Cmd CommentAdd: respect non-interactive option * Cmd CommentEdit: respect non-interactive option * Cmd TermUI: respect non-interactive option * Cmd TitleEdit: respect non-interactive option * Remove global non-interactive option * Cmd UserCreate: Use local non-interactive option * Cmd BugAdd: Use local non-interactive option * Cmd BridgeConfigure: Use local non-interactive option * Cmd CommentAdd: Use local non-interactive option * Cmd CommentEdit: Use local non-interactive option * Cmd TermUI: Drop non-interactive option It should be obviouse that the termui is an interactive command. * Cmd TitleEdit: Use local non-interactive option * Update docs * Bridge GitHub: respect non-interactive option * Bridge GitLab: respect non-interactive option * Bridge Jira: respect non-interactive and token opt * Fix failing compilation * Bridge launchpad: respect non-interactive option * bridge: isNonInteractive --> interactive Co-authored-by: Michael Muré <batolettre@gmail.com> 2021-05-09 12:14:45 +03:00			`.PP`
update gqlgen 2022-02-15 21:57:26 +03:00			`\fB--non-interactive\fP[=false]`
CLI: Add non-interactive option to interactive commands (#651) * Add option to skip the AvatarURL input request Using an empty string for the avatar cli flag e.g. `git-bug user create -a ""` will still result in a prompt. As the avatar URL is an optional option, it should be possible to skip asking for it entirely. Otherwise automated user creation via a script must make use of pipe hacks. * Add global --non-interactive cmdline option * Replace --skipAvatar for --non-interactive option * Cmd BugAdd: respect non-interactive option * Cmd bridge configure: respect non-interactive opt * Cmd CommentAdd: respect non-interactive option * Cmd CommentEdit: respect non-interactive option * Cmd TermUI: respect non-interactive option * Cmd TitleEdit: respect non-interactive option * Remove global non-interactive option * Cmd UserCreate: Use local non-interactive option * Cmd BugAdd: Use local non-interactive option * Cmd BridgeConfigure: Use local non-interactive option * Cmd CommentAdd: Use local non-interactive option * Cmd CommentEdit: Use local non-interactive option * Cmd TermUI: Drop non-interactive option It should be obviouse that the termui is an interactive command. * Cmd TitleEdit: Use local non-interactive option * Update docs * Bridge GitHub: respect non-interactive option * Bridge GitLab: respect non-interactive option * Bridge Jira: respect non-interactive and token opt * Fix failing compilation * Bridge launchpad: respect non-interactive option * bridge: isNonInteractive --> interactive Co-authored-by: Michael Muré <batolettre@gmail.com> 2021-05-09 12:14:45 +03:00			`Do not ask for user input`

commands: add the "bridge" and "bridge configure" commands 2018-09-24 16:25:57 +03:00			`.PP`
update gqlgen 2022-02-15 21:57:26 +03:00			`\fB-h\fP, \fB--help\fP[=false]`
commands: reorg into different packages 2022-09-10 12:09:19 +03:00			`help for new`
commands: add the "bridge" and "bridge configure" commands 2018-09-24 16:25:57 +03:00

Update man pages and bash_completion 2019-05-29 21:50:30 +03:00			`.SH EXAMPLE`
			`.PP`
			`.RS`

			`.nf`
			`# Interactive example`
			`[1]: github`
bridges: massive refactor - automatic flag validation and warning - generalized prompt - cleanups 2020-02-15 04:55:19 +03:00			`[2]: gitlab`
			`[3]: jira`
update gqlgen 2022-02-15 21:57:26 +03:00			`[4]: launchpad-preview`
bridges: massive refactor - automatic flag validation and warning - generalized prompt - cleanups 2020-02-15 04:55:19 +03:00
Update man pages and bash_completion 2019-05-29 21:50:30 +03:00			`target: 1`
			`name [default]: default`

			`Detected projects:`
update gqlgen 2022-02-15 21:57:26 +03:00			`[1]: github.com/a-hilaly/git-bug`
			`[2]: github.com/MichaelMure/git-bug`
Update man pages and bash_completion 2019-05-29 21:50:30 +03:00
			`[0]: Another project`

			`Select option: 1`

rename GITHUB_TOKEN to GITHUB_PRIVATE_TOKEN 2019-06-07 02:28:52 +03:00			`[1]: user provided token`
			`[2]: interactive token creation`
			`Select option: 1`
Update man pages and bash_completion 2019-05-29 21:50:30 +03:00
			`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:`
update gqlgen 2022-02-15 21:57:26 +03:00			`- 'public_repo': to be able to read public repositories`
Update man pages and bash_completion 2019-05-29 21:50:30 +03:00			`Private:`
update gqlgen 2022-02-15 21:57:26 +03:00			`- 'repo' : to be able to read private repositories`
Update man pages and bash_completion 2019-05-29 21:50:30 +03:00
rename GITHUB_TOKEN to GITHUB_PRIVATE_TOKEN 2019-06-07 02:28:52 +03:00			`Enter token: 87cf5c03b64029f18ea5f9ca5679daa08ccbd700`
Update man pages and bash_completion 2019-05-29 21:50:30 +03:00			`Successfully configured bridge: default`

doc/man: update generated documentations 2019-08-27 01:53:26 +03:00			`# For GitHub`
commands: reorg into different packages 2022-09-10 12:09:19 +03:00			`git bug bridge new \\`
update gqlgen 2022-02-15 21:57:26 +03:00			`--name=default \\`
			`--target=github \\`
			`--owner=$(OWNER) \\`
			`--project=$(PROJECT) \\`
			`--token=$(TOKEN)`
Update man pages and bash_completion 2019-05-29 21:50:30 +03:00
			`# For Launchpad`
commands: reorg into different packages 2022-09-10 12:09:19 +03:00			`git bug bridge new \\`
update gqlgen 2022-02-15 21:57:26 +03:00			`--name=default \\`
			`--target=launchpad-preview \\`
doc: fix incorrect indentation fix #905 2022-10-22 16:56:36 +03:00			`--url=https://bugs.launchpad.net/ubuntu/`
doc/man: update generated documentations 2019-08-27 01:53:26 +03:00
			`# For Gitlab`
commands: reorg into different packages 2022-09-10 12:09:19 +03:00			`git bug bridge new \\`
update gqlgen 2022-02-15 21:57:26 +03:00			`--name=default \\`
			`--target=github \\`
			`--url=https://github.com/michaelmure/git-bug \\`
			`--token=$(TOKEN)`
Update man pages and bash_completion 2019-05-29 21:50:30 +03:00
			`.fi`
			`.RE`


commands: add the "bridge" and "bridge configure" commands 2018-09-24 16:25:57 +03:00			`.SH SEE ALSO`
			`.PP`
update gqlgen 2022-02-15 21:57:26 +03:00			`\fBgit-bug-bridge(1)\fP`