diff options
Diffstat (limited to 'doc/md')
47 files changed, 299 insertions, 299 deletions
diff --git a/doc/md/git-bug.md b/doc/md/git-bug.md index c47f84845..b311aff59 100644 --- a/doc/md/git-bug.md +++ b/doc/md/git-bug.md @@ -1,6 +1,6 @@ ## git-bug -A bug tracker embedded in Git. +A bug tracker embedded in Git ### Synopsis @@ -24,22 +24,14 @@ git-bug [flags] ### SEE ALSO -* [git-bug add](git-bug_add.md) - Create a new bug. -* [git-bug bridge](git-bug_bridge.md) - Configure and use bridges to other bug trackers. +* [git-bug bridge](git-bug_bridge.md) - List bridges to other bug trackers +* [git-bug bug](git-bug_bug.md) - List bugs * [git-bug commands](git-bug_commands.md) - Display available commands. -* [git-bug comment](git-bug_comment.md) - Display or add comments to a bug. -* [git-bug deselect](git-bug_deselect.md) - Clear the implicitly selected bug. -* [git-bug label](git-bug_label.md) - Display, add or remove labels to/from a bug. -* [git-bug ls](git-bug_ls.md) - List bugs. -* [git-bug pull](git-bug_pull.md) - Pull bugs update from a git remote. -* [git-bug push](git-bug_push.md) - Push bugs update to a git remote. -* [git-bug rm](git-bug_rm.md) - Remove an existing bug. -* [git-bug select](git-bug_select.md) - Select a bug for implicit use in future commands. -* [git-bug show](git-bug_show.md) - Display the details of a bug. -* [git-bug status](git-bug_status.md) - Display or change a bug status. -* [git-bug termui](git-bug_termui.md) - Launch the terminal UI. -* [git-bug title](git-bug_title.md) - Display or change a title of a bug. -* [git-bug user](git-bug_user.md) - Display or change the user identity. -* [git-bug version](git-bug_version.md) - Show git-bug version information. -* [git-bug webui](git-bug_webui.md) - Launch the web UI. +* [git-bug label](git-bug_label.md) - List valid labels +* [git-bug pull](git-bug_pull.md) - Pull updates from a git remote +* [git-bug push](git-bug_push.md) - Push updates to a git remote +* [git-bug termui](git-bug_termui.md) - Launch the terminal UI +* [git-bug user](git-bug_user.md) - List identities +* [git-bug version](git-bug_version.md) - Show git-bug version information +* [git-bug webui](git-bug_webui.md) - Launch the web UI diff --git a/doc/md/git-bug_bridge.md b/doc/md/git-bug_bridge.md index e8b6e3823..c3e239e2e 100644 --- a/doc/md/git-bug_bridge.md +++ b/doc/md/git-bug_bridge.md @@ -1,6 +1,6 @@ ## git-bug bridge -Configure and use bridges to other bug trackers. +List bridges to other bug trackers ``` git-bug bridge [flags] @@ -14,10 +14,10 @@ git-bug bridge [flags] ### SEE ALSO -* [git-bug](git-bug.md) - A bug tracker embedded in Git. -* [git-bug bridge auth](git-bug_bridge_auth.md) - List all known bridge authentication credentials. -* [git-bug bridge configure](git-bug_bridge_configure.md) - Configure a new bridge. -* [git-bug bridge pull](git-bug_bridge_pull.md) - Pull updates. -* [git-bug bridge push](git-bug_bridge_push.md) - Push updates. -* [git-bug bridge rm](git-bug_bridge_rm.md) - Delete a configured bridge. +* [git-bug](git-bug.md) - A bug tracker embedded in Git +* [git-bug bridge auth](git-bug_bridge_auth.md) - List all known bridge authentication credentials +* [git-bug bridge new](git-bug_bridge_new.md) - Configure a new bridge +* [git-bug bridge pull](git-bug_bridge_pull.md) - Pull updates from a remote bug tracker +* [git-bug bridge push](git-bug_bridge_push.md) - Push updates to remote bug tracker +* [git-bug bridge rm](git-bug_bridge_rm.md) - Delete a configured bridge diff --git a/doc/md/git-bug_bridge_auth.md b/doc/md/git-bug_bridge_auth.md index bcaf60283..e74048229 100644 --- a/doc/md/git-bug_bridge_auth.md +++ b/doc/md/git-bug_bridge_auth.md @@ -1,6 +1,6 @@ ## git-bug bridge auth -List all known bridge authentication credentials. +List all known bridge authentication credentials ``` git-bug bridge auth [flags] @@ -14,8 +14,8 @@ git-bug bridge auth [flags] ### SEE ALSO -* [git-bug bridge](git-bug_bridge.md) - Configure and use bridges to other bug trackers. +* [git-bug bridge](git-bug_bridge.md) - List bridges to other bug trackers * [git-bug bridge auth add-token](git-bug_bridge_auth_add-token.md) - Store a new token -* [git-bug bridge auth rm](git-bug_bridge_auth_rm.md) - Remove a credential. -* [git-bug bridge auth show](git-bug_bridge_auth_show.md) - Display an authentication credential. +* [git-bug bridge auth rm](git-bug_bridge_auth_rm.md) - Remove a credential +* [git-bug bridge auth show](git-bug_bridge_auth_show.md) - Display an authentication credential diff --git a/doc/md/git-bug_bridge_auth_add-token.md b/doc/md/git-bug_bridge_auth_add-token.md index faafaf61c..3fb33036c 100644 --- a/doc/md/git-bug_bridge_auth_add-token.md +++ b/doc/md/git-bug_bridge_auth_add-token.md @@ -17,5 +17,5 @@ git-bug bridge auth add-token [TOKEN] [flags] ### SEE ALSO -* [git-bug bridge auth](git-bug_bridge_auth.md) - List all known bridge authentication credentials. +* [git-bug bridge auth](git-bug_bridge_auth.md) - List all known bridge authentication credentials diff --git a/doc/md/git-bug_bridge_auth_rm.md b/doc/md/git-bug_bridge_auth_rm.md index d890054ee..8ae3ad526 100644 --- a/doc/md/git-bug_bridge_auth_rm.md +++ b/doc/md/git-bug_bridge_auth_rm.md @@ -1,9 +1,9 @@ ## git-bug bridge auth rm -Remove a credential. +Remove a credential ``` -git-bug bridge auth rm ID [flags] +git-bug bridge auth rm BRIDGE_ID [flags] ``` ### Options @@ -14,5 +14,5 @@ git-bug bridge auth rm ID [flags] ### SEE ALSO -* [git-bug bridge auth](git-bug_bridge_auth.md) - List all known bridge authentication credentials. +* [git-bug bridge auth](git-bug_bridge_auth.md) - List all known bridge authentication credentials diff --git a/doc/md/git-bug_bridge_auth_show.md b/doc/md/git-bug_bridge_auth_show.md index 18d468db3..f73bb8768 100644 --- a/doc/md/git-bug_bridge_auth_show.md +++ b/doc/md/git-bug_bridge_auth_show.md @@ -1,6 +1,6 @@ ## git-bug bridge auth show -Display an authentication credential. +Display an authentication credential ``` git-bug bridge auth show [flags] @@ -14,5 +14,5 @@ git-bug bridge auth show [flags] ### SEE ALSO -* [git-bug bridge auth](git-bug_bridge_auth.md) - List all known bridge authentication credentials. +* [git-bug bridge auth](git-bug_bridge_auth.md) - List all known bridge authentication credentials diff --git a/doc/md/git-bug_bridge_configure.md b/doc/md/git-bug_bridge_new.md index e3b4c6bdc..81bffd49a 100644 --- a/doc/md/git-bug_bridge_configure.md +++ b/doc/md/git-bug_bridge_new.md @@ -1,13 +1,13 @@ -## git-bug bridge configure +## git-bug bridge new -Configure a new bridge. +Configure a new bridge ### Synopsis 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. ``` -git-bug bridge configure [flags] +git-bug bridge new [flags] ``` ### Examples @@ -47,7 +47,7 @@ Enter token: 87cf5c03b64029f18ea5f9ca5679daa08ccbd700 Successfully configured bridge: default # For GitHub -git bug bridge configure \ +git bug bridge new \ --name=default \ --target=github \ --owner=$(OWNER) \ @@ -55,13 +55,13 @@ git bug bridge configure \ --token=$(TOKEN) # For Launchpad -git bug bridge configure \ +git bug bridge new \ --name=default \ --target=launchpad-preview \ --url=https://bugs.launchpad.net/ubuntu/ # For Gitlab -git bug bridge configure \ +git bug bridge new \ --name=default \ --target=github \ --url=https://github.com/michaelmure/git-bug \ @@ -82,10 +82,10 @@ git bug bridge configure \ -o, --owner string The owner of the remote repository -p, --project string The name of the remote repository --non-interactive Do not ask for user input - -h, --help help for configure + -h, --help help for new ``` ### SEE ALSO -* [git-bug bridge](git-bug_bridge.md) - Configure and use bridges to other bug trackers. +* [git-bug bridge](git-bug_bridge.md) - List bridges to other bug trackers diff --git a/doc/md/git-bug_bridge_pull.md b/doc/md/git-bug_bridge_pull.md index b1ce21692..0975010a4 100644 --- a/doc/md/git-bug_bridge_pull.md +++ b/doc/md/git-bug_bridge_pull.md @@ -1,6 +1,6 @@ ## git-bug bridge pull -Pull updates. +Pull updates from a remote bug tracker ``` git-bug bridge pull [NAME] [flags] @@ -16,5 +16,5 @@ git-bug bridge pull [NAME] [flags] ### SEE ALSO -* [git-bug bridge](git-bug_bridge.md) - Configure and use bridges to other bug trackers. +* [git-bug bridge](git-bug_bridge.md) - List bridges to other bug trackers diff --git a/doc/md/git-bug_bridge_push.md b/doc/md/git-bug_bridge_push.md index a532a26d6..c7e1a86d0 100644 --- a/doc/md/git-bug_bridge_push.md +++ b/doc/md/git-bug_bridge_push.md @@ -1,6 +1,6 @@ ## git-bug bridge push -Push updates. +Push updates to remote bug tracker ``` git-bug bridge push [NAME] [flags] @@ -14,5 +14,5 @@ git-bug bridge push [NAME] [flags] ### SEE ALSO -* [git-bug bridge](git-bug_bridge.md) - Configure and use bridges to other bug trackers. +* [git-bug bridge](git-bug_bridge.md) - List bridges to other bug trackers diff --git a/doc/md/git-bug_bridge_rm.md b/doc/md/git-bug_bridge_rm.md index 6d8ff67cb..2b3baf710 100644 --- a/doc/md/git-bug_bridge_rm.md +++ b/doc/md/git-bug_bridge_rm.md @@ -1,6 +1,6 @@ ## git-bug bridge rm -Delete a configured bridge. +Delete a configured bridge ``` git-bug bridge rm NAME [flags] @@ -14,5 +14,5 @@ git-bug bridge rm NAME [flags] ### SEE ALSO -* [git-bug bridge](git-bug_bridge.md) - Configure and use bridges to other bug trackers. +* [git-bug bridge](git-bug_bridge.md) - List bridges to other bug trackers diff --git a/doc/md/git-bug_ls.md b/doc/md/git-bug_bug.md index 5aec0fbc4..c040cd164 100644 --- a/doc/md/git-bug_ls.md +++ b/doc/md/git-bug_bug.md @@ -1,6 +1,6 @@ -## git-bug ls +## git-bug bug -List bugs. +List bugs ### Synopsis @@ -9,23 +9,23 @@ Display a summary of each bugs. You can pass an additional query to filter and order the list. This query can be expressed either with a simple query language, flags, a natural language full text search, or a combination of the aforementioned. ``` -git-bug ls [QUERY] [flags] +git-bug bug [QUERY] [flags] ``` ### Examples ``` List open bugs sorted by last edition with a query: -git bug ls status:open sort:edit-desc +git bug status:open sort:edit-desc List closed bugs sorted by creation with flags: -git bug ls --status closed --by creation +git bug --status closed --by creation Do a full text search of all bugs: -git bug ls "foo bar" baz +git bug "foo bar" baz Use queries, flags, and full text search: -git bug ls status:open --by creation "foo bar" baz +git bug status:open --by creation "foo bar" baz ``` @@ -43,10 +43,19 @@ git bug ls status:open --by creation "foo bar" baz -b, --by string Sort the results by a characteristic. Valid values are [id,creation,edit] (default "creation") -d, --direction string Select the sorting direction. Valid values are [asc,desc] (default "asc") -f, --format string Select the output formatting style. Valid values are [default,plain,compact,id,json,org-mode] (default "default") - -h, --help help for ls + -h, --help help for bug ``` ### SEE ALSO -* [git-bug](git-bug.md) - A bug tracker embedded in Git. +* [git-bug](git-bug.md) - A bug tracker embedded in Git +* [git-bug bug comment](git-bug_bug_comment.md) - List a bug's comments +* [git-bug bug deselect](git-bug_bug_deselect.md) - Clear the implicitly selected bug +* [git-bug bug label](git-bug_bug_label.md) - Display labels of a bug +* [git-bug bug new](git-bug_bug_new.md) - Create a new bug +* [git-bug bug rm](git-bug_bug_rm.md) - Remove an existing bug +* [git-bug bug select](git-bug_bug_select.md) - Select a bug for implicit use in future commands +* [git-bug bug show](git-bug_bug_show.md) - Display the details of a bug +* [git-bug bug status](git-bug_bug_status.md) - Display the status of a bug +* [git-bug bug title](git-bug_bug_title.md) - Display the title of a bug diff --git a/doc/md/git-bug_bug_comment.md b/doc/md/git-bug_bug_comment.md new file mode 100644 index 000000000..6d56a8739 --- /dev/null +++ b/doc/md/git-bug_bug_comment.md @@ -0,0 +1,20 @@ +## git-bug bug comment + +List a bug's comments + +``` +git-bug bug comment [BUG_ID] [flags] +``` + +### Options + +``` + -h, --help help for comment +``` + +### SEE ALSO + +* [git-bug bug](git-bug_bug.md) - List bugs +* [git-bug bug comment edit](git-bug_bug_comment_edit.md) - Edit an existing comment on a bug +* [git-bug bug comment new](git-bug_bug_comment_new.md) - Add a new comment to a bug + diff --git a/doc/md/git-bug_comment_edit.md b/doc/md/git-bug_bug_comment_edit.md index 1a53b4394..86a0a4e62 100644 --- a/doc/md/git-bug_comment_edit.md +++ b/doc/md/git-bug_bug_comment_edit.md @@ -1,9 +1,9 @@ -## git-bug comment edit +## git-bug bug comment edit -Edit an existing comment on a bug. +Edit an existing comment on a bug ``` -git-bug comment edit [COMMENT_ID] [flags] +git-bug bug comment edit [COMMENT_ID] [flags] ``` ### Options @@ -17,5 +17,5 @@ git-bug comment edit [COMMENT_ID] [flags] ### SEE ALSO -* [git-bug comment](git-bug_comment.md) - Display or add comments to a bug. +* [git-bug bug comment](git-bug_bug_comment.md) - List a bug's comments diff --git a/doc/md/git-bug_comment_add.md b/doc/md/git-bug_bug_comment_new.md index 5a199aba5..b1ba697bb 100644 --- a/doc/md/git-bug_comment_add.md +++ b/doc/md/git-bug_bug_comment_new.md @@ -1,9 +1,9 @@ -## git-bug comment add +## git-bug bug comment new -Add a new comment to a bug. +Add a new comment to a bug ``` -git-bug comment add [ID] [flags] +git-bug bug comment new [BUG_ID] [flags] ``` ### Options @@ -12,10 +12,10 @@ git-bug comment add [ID] [flags] -F, --file string Take the message from the given file. Use - to read the message from the standard input -m, --message string Provide the new message from the command line --non-interactive Do not ask for user input - -h, --help help for add + -h, --help help for new ``` ### SEE ALSO -* [git-bug comment](git-bug_comment.md) - Display or add comments to a bug. +* [git-bug bug comment](git-bug_bug_comment.md) - List a bug's comments diff --git a/doc/md/git-bug_deselect.md b/doc/md/git-bug_bug_deselect.md index 51ce5dda4..d41360683 100644 --- a/doc/md/git-bug_deselect.md +++ b/doc/md/git-bug_bug_deselect.md @@ -1,9 +1,9 @@ -## git-bug deselect +## git-bug bug deselect -Clear the implicitly selected bug. +Clear the implicitly selected bug ``` -git-bug deselect [flags] +git-bug bug deselect [flags] ``` ### Examples @@ -24,5 +24,5 @@ git bug deselect ### SEE ALSO -* [git-bug](git-bug.md) - A bug tracker embedded in Git. +* [git-bug bug](git-bug_bug.md) - List bugs diff --git a/doc/md/git-bug_bug_label.md b/doc/md/git-bug_bug_label.md new file mode 100644 index 000000000..ac5fb985f --- /dev/null +++ b/doc/md/git-bug_bug_label.md @@ -0,0 +1,20 @@ +## git-bug bug label + +Display labels of a bug + +``` +git-bug bug label [BUG_ID] [flags] +``` + +### Options + +``` + -h, --help help for label +``` + +### SEE ALSO + +* [git-bug bug](git-bug_bug.md) - List bugs +* [git-bug bug label new](git-bug_bug_label_new.md) - Add a label to a bug +* [git-bug bug label rm](git-bug_bug_label_rm.md) - Remove a label from a bug + diff --git a/doc/md/git-bug_bug_label_new.md b/doc/md/git-bug_bug_label_new.md new file mode 100644 index 000000000..ada978dc0 --- /dev/null +++ b/doc/md/git-bug_bug_label_new.md @@ -0,0 +1,18 @@ +## git-bug bug label new + +Add a label to a bug + +``` +git-bug bug label new [BUG_ID] LABEL... [flags] +``` + +### Options + +``` + -h, --help help for new +``` + +### SEE ALSO + +* [git-bug bug label](git-bug_bug_label.md) - Display labels of a bug + diff --git a/doc/md/git-bug_bug_label_rm.md b/doc/md/git-bug_bug_label_rm.md new file mode 100644 index 000000000..7899b1be8 --- /dev/null +++ b/doc/md/git-bug_bug_label_rm.md @@ -0,0 +1,18 @@ +## git-bug bug label rm + +Remove a label from a bug + +``` +git-bug bug label rm [BUG_ID] LABEL... [flags] +``` + +### Options + +``` + -h, --help help for rm +``` + +### SEE ALSO + +* [git-bug bug label](git-bug_bug_label.md) - Display labels of a bug + diff --git a/doc/md/git-bug_add.md b/doc/md/git-bug_bug_new.md index 5e7486105..4dacc5fd7 100644 --- a/doc/md/git-bug_add.md +++ b/doc/md/git-bug_bug_new.md @@ -1,9 +1,9 @@ -## git-bug add +## git-bug bug new -Create a new bug. +Create a new bug ``` -git-bug add [flags] +git-bug bug new [flags] ``` ### Options @@ -13,10 +13,10 @@ git-bug add [flags] -m, --message string Provide a message to describe the issue -F, --file string Take the message from the given file. Use - to read the message from the standard input --non-interactive Do not ask for user input - -h, --help help for add + -h, --help help for new ``` ### SEE ALSO -* [git-bug](git-bug.md) - A bug tracker embedded in Git. +* [git-bug bug](git-bug_bug.md) - List bugs diff --git a/doc/md/git-bug_rm.md b/doc/md/git-bug_bug_rm.md index 3b77ce1c1..2e77c6ec3 100644 --- a/doc/md/git-bug_rm.md +++ b/doc/md/git-bug_bug_rm.md @@ -1,13 +1,13 @@ -## git-bug rm +## git-bug bug rm -Remove an existing bug. +Remove an existing bug ### Synopsis Remove an existing bug in the local repository. Note removing bugs that were imported from bridges will not remove the bug on the remote, and will only remove the local copy of the bug. ``` -git-bug rm ID [flags] +git-bug bug rm BUG_ID [flags] ``` ### Options @@ -18,5 +18,5 @@ git-bug rm ID [flags] ### SEE ALSO -* [git-bug](git-bug.md) - A bug tracker embedded in Git. +* [git-bug bug](git-bug_bug.md) - List bugs diff --git a/doc/md/git-bug_select.md b/doc/md/git-bug_bug_select.md index b8a711204..d529c5448 100644 --- a/doc/md/git-bug_select.md +++ b/doc/md/git-bug_bug_select.md @@ -1,6 +1,6 @@ -## git-bug select +## git-bug bug select -Select a bug for implicit use in future commands. +Select a bug for implicit use in future commands ### Synopsis @@ -15,7 +15,7 @@ The complementary command is "git bug deselect" performing the opposite operatio ``` -git-bug select ID [flags] +git-bug bug select BUG_ID [flags] ``` ### Examples @@ -35,5 +35,5 @@ git bug status ### SEE ALSO -* [git-bug](git-bug.md) - A bug tracker embedded in Git. +* [git-bug bug](git-bug_bug.md) - List bugs diff --git a/doc/md/git-bug_show.md b/doc/md/git-bug_bug_show.md index c284fc710..1c7b762fb 100644 --- a/doc/md/git-bug_show.md +++ b/doc/md/git-bug_bug_show.md @@ -1,9 +1,9 @@ -## git-bug show +## git-bug bug show -Display the details of a bug. +Display the details of a bug ``` -git-bug show [ID] [flags] +git-bug bug show [BUG_ID] [flags] ``` ### Options @@ -16,5 +16,5 @@ git-bug show [ID] [flags] ### SEE ALSO -* [git-bug](git-bug.md) - A bug tracker embedded in Git. +* [git-bug bug](git-bug_bug.md) - List bugs diff --git a/doc/md/git-bug_bug_status.md b/doc/md/git-bug_bug_status.md new file mode 100644 index 000000000..6e71e4584 --- /dev/null +++ b/doc/md/git-bug_bug_status.md @@ -0,0 +1,20 @@ +## git-bug bug status + +Display the status of a bug + +``` +git-bug bug status [BUG_ID] [flags] +``` + +### Options + +``` + -h, --help help for status +``` + +### SEE ALSO + +* [git-bug bug](git-bug_bug.md) - List bugs +* [git-bug bug status close](git-bug_bug_status_close.md) - Mark a bug as closed +* [git-bug bug status open](git-bug_bug_status_open.md) - Mark a bug as open + diff --git a/doc/md/git-bug_bug_status_close.md b/doc/md/git-bug_bug_status_close.md new file mode 100644 index 000000000..f63fabb54 --- /dev/null +++ b/doc/md/git-bug_bug_status_close.md @@ -0,0 +1,18 @@ +## git-bug bug status close + +Mark a bug as closed + +``` +git-bug bug status close [BUG_ID] [flags] +``` + +### Options + +``` + -h, --help help for close +``` + +### SEE ALSO + +* [git-bug bug status](git-bug_bug_status.md) - Display the status of a bug + diff --git a/doc/md/git-bug_bug_status_open.md b/doc/md/git-bug_bug_status_open.md new file mode 100644 index 000000000..0899de30c --- /dev/null +++ b/doc/md/git-bug_bug_status_open.md @@ -0,0 +1,18 @@ +## git-bug bug status open + +Mark a bug as open + +``` +git-bug bug status open [BUG_ID] [flags] +``` + +### Options + +``` + -h, --help help for open +``` + +### SEE ALSO + +* [git-bug bug status](git-bug_bug_status.md) - Display the status of a bug + diff --git a/doc/md/git-bug_bug_title.md b/doc/md/git-bug_bug_title.md new file mode 100644 index 000000000..2650487e0 --- /dev/null +++ b/doc/md/git-bug_bug_title.md @@ -0,0 +1,19 @@ +## git-bug bug title + +Display the title of a bug + +``` +git-bug bug title [BUG_ID] [flags] +``` + +### Options + +``` + -h, --help help for title +``` + +### SEE ALSO + +* [git-bug bug](git-bug_bug.md) - List bugs +* [git-bug bug title edit](git-bug_bug_title_edit.md) - Edit a title of a bug + diff --git a/doc/md/git-bug_title_edit.md b/doc/md/git-bug_bug_title_edit.md index ae060680b..0a26609de 100644 --- a/doc/md/git-bug_title_edit.md +++ b/doc/md/git-bug_bug_title_edit.md @@ -1,9 +1,9 @@ -## git-bug title edit +## git-bug bug title edit -Edit a title of a bug. +Edit a title of a bug ``` -git-bug title edit [ID] [flags] +git-bug bug title edit [BUG_ID] [flags] ``` ### Options @@ -16,5 +16,5 @@ git-bug title edit [ID] [flags] ### SEE ALSO -* [git-bug title](git-bug_title.md) - Display or change a title of a bug. +* [git-bug bug title](git-bug_bug_title.md) - Display the title of a bug diff --git a/doc/md/git-bug_commands.md b/doc/md/git-bug_commands.md index db1054f8b..bce599dd9 100644 --- a/doc/md/git-bug_commands.md +++ b/doc/md/git-bug_commands.md @@ -15,5 +15,5 @@ git-bug commands [flags] ### SEE ALSO -* [git-bug](git-bug.md) - A bug tracker embedded in Git. +* [git-bug](git-bug.md) - A bug tracker embedded in Git diff --git a/doc/md/git-bug_comment.md b/doc/md/git-bug_comment.md deleted file mode 100644 index 48050a979..000000000 --- a/doc/md/git-bug_comment.md +++ /dev/null @@ -1,20 +0,0 @@ -## git-bug comment - -Display or add comments to a bug. - -``` -git-bug comment [ID] [flags] -``` - -### Options - -``` - -h, --help help for comment -``` - -### SEE ALSO - -* [git-bug](git-bug.md) - A bug tracker embedded in Git. -* [git-bug comment add](git-bug_comment_add.md) - Add a new comment to a bug. -* [git-bug comment edit](git-bug_comment_edit.md) - Edit an existing comment on a bug. - diff --git a/doc/md/git-bug_label.md b/doc/md/git-bug_label.md index caeebe894..969edc16f 100644 --- a/doc/md/git-bug_label.md +++ b/doc/md/git-bug_label.md @@ -1,9 +1,15 @@ ## git-bug label -Display, add or remove labels to/from a bug. +List valid labels + +### Synopsis + +List valid labels. + +Note: in the future, a proper label policy could be implemented where valid labels are defined in a configuration file. Until that, the default behavior is to return the list of labels already used. ``` -git-bug label [ID] [flags] +git-bug label [flags] ``` ### Options @@ -14,8 +20,5 @@ git-bug label [ID] [flags] ### SEE ALSO -* [git-bug](git-bug.md) - A bug tracker embedded in Git. -* [git-bug label add](git-bug_label_add.md) - Add a label to a bug. -* [git-bug label ls](git-bug_label_ls.md) - List valid labels. -* [git-bug label rm](git-bug_label_rm.md) - Remove a label from a bug. +* [git-bug](git-bug.md) - A bug tracker embedded in Git diff --git a/doc/md/git-bug_label_add.md b/doc/md/git-bug_label_add.md deleted file mode 100644 index c90b45d31..000000000 --- a/doc/md/git-bug_label_add.md +++ /dev/null @@ -1,18 +0,0 @@ -## git-bug label add - -Add a label to a bug. - -``` -git-bug label add [ID] LABEL... [flags] -``` - -### Options - -``` - -h, --help help for add -``` - -### SEE ALSO - -* [git-bug label](git-bug_label.md) - Display, add or remove labels to/from a bug. - diff --git a/doc/md/git-bug_label_ls.md b/doc/md/git-bug_label_ls.md deleted file mode 100644 index cda6ebba7..000000000 --- a/doc/md/git-bug_label_ls.md +++ /dev/null @@ -1,24 +0,0 @@ -## git-bug label ls - -List valid labels. - -### Synopsis - -List valid labels. - -Note: in the future, a proper label policy could be implemented where valid labels are defined in a configuration file. Until that, the default behavior is to return the list of labels already used. - -``` -git-bug label ls [flags] -``` - -### Options - -``` - -h, --help help for ls -``` - -### SEE ALSO - -* [git-bug label](git-bug_label.md) - Display, add or remove labels to/from a bug. - diff --git a/doc/md/git-bug_label_rm.md b/doc/md/git-bug_label_rm.md deleted file mode 100644 index 15982d0ea..000000000 --- a/doc/md/git-bug_label_rm.md +++ /dev/null @@ -1,18 +0,0 @@ -## git-bug label rm - -Remove a label from a bug. - -``` -git-bug label rm [ID] LABEL... [flags] -``` - -### Options - -``` - -h, --help help for rm -``` - -### SEE ALSO - -* [git-bug label](git-bug_label.md) - Display, add or remove labels to/from a bug. - diff --git a/doc/md/git-bug_pull.md b/doc/md/git-bug_pull.md index 5c1d51b6a..28f90959c 100644 --- a/doc/md/git-bug_pull.md +++ b/doc/md/git-bug_pull.md @@ -1,6 +1,6 @@ ## git-bug pull -Pull bugs update from a git remote. +Pull updates from a git remote ``` git-bug pull [REMOTE] [flags] @@ -14,5 +14,5 @@ git-bug pull [REMOTE] [flags] ### SEE ALSO -* [git-bug](git-bug.md) - A bug tracker embedded in Git. +* [git-bug](git-bug.md) - A bug tracker embedded in Git diff --git a/doc/md/git-bug_push.md b/doc/md/git-bug_push.md index 187797006..a0213a01e 100644 --- a/doc/md/git-bug_push.md +++ b/doc/md/git-bug_push.md @@ -1,6 +1,6 @@ ## git-bug push -Push bugs update to a git remote. +Push updates to a git remote ``` git-bug push [REMOTE] [flags] @@ -14,5 +14,5 @@ git-bug push [REMOTE] [flags] ### SEE ALSO -* [git-bug](git-bug.md) - A bug tracker embedded in Git. +* [git-bug](git-bug.md) - A bug tracker embedded in Git diff --git a/doc/md/git-bug_status.md b/doc/md/git-bug_status.md deleted file mode 100644 index 9eb56c6be..000000000 --- a/doc/md/git-bug_status.md +++ /dev/null @@ -1,20 +0,0 @@ -## git-bug status - -Display or change a bug status. - -``` -git-bug status [ID] [flags] -``` - -### Options - -``` - -h, --help help for status -``` - -### SEE ALSO - -* [git-bug](git-bug.md) - A bug tracker embedded in Git. -* [git-bug status close](git-bug_status_close.md) - Mark a bug as closed. -* [git-bug status open](git-bug_status_open.md) - Mark a bug as open. - diff --git a/doc/md/git-bug_status_close.md b/doc/md/git-bug_status_close.md deleted file mode 100644 index aee726491..000000000 --- a/doc/md/git-bug_status_close.md +++ /dev/null @@ -1,18 +0,0 @@ -## git-bug status close - -Mark a bug as closed. - -``` -git-bug status close [ID] [flags] -``` - -### Options - -``` - -h, --help help for close -``` - -### SEE ALSO - -* [git-bug status](git-bug_status.md) - Display or change a bug status. - diff --git a/doc/md/git-bug_status_open.md b/doc/md/git-bug_status_open.md deleted file mode 100644 index 332a1d96d..000000000 --- a/doc/md/git-bug_status_open.md +++ /dev/null @@ -1,18 +0,0 @@ -## git-bug status open - -Mark a bug as open. - -``` -git-bug status open [ID] [flags] -``` - -### Options - -``` - -h, --help help for open -``` - -### SEE ALSO - -* [git-bug status](git-bug_status.md) - Display or change a bug status. - diff --git a/doc/md/git-bug_termui.md b/doc/md/git-bug_termui.md index 3da6869e7..ccab380c4 100644 --- a/doc/md/git-bug_termui.md +++ b/doc/md/git-bug_termui.md @@ -1,6 +1,6 @@ ## git-bug termui -Launch the terminal UI. +Launch the terminal UI ``` git-bug termui [flags] @@ -14,5 +14,5 @@ git-bug termui [flags] ### SEE ALSO -* [git-bug](git-bug.md) - A bug tracker embedded in Git. +* [git-bug](git-bug.md) - A bug tracker embedded in Git diff --git a/doc/md/git-bug_title.md b/doc/md/git-bug_title.md deleted file mode 100644 index 791fcb75b..000000000 --- a/doc/md/git-bug_title.md +++ /dev/null @@ -1,19 +0,0 @@ -## git-bug title - -Display or change a title of a bug. - -``` -git-bug title [ID] [flags] -``` - -### Options - -``` - -h, --help help for title -``` - -### SEE ALSO - -* [git-bug](git-bug.md) - A bug tracker embedded in Git. -* [git-bug title edit](git-bug_title_edit.md) - Edit a title of a bug. - diff --git a/doc/md/git-bug_user.md b/doc/md/git-bug_user.md index 302a1eda8..869397050 100644 --- a/doc/md/git-bug_user.md +++ b/doc/md/git-bug_user.md @@ -1,22 +1,22 @@ ## git-bug user -Display or change the user identity. +List identities ``` -git-bug user [USER-ID] [flags] +git-bug user [flags] ``` ### Options ``` - -f, --field string Select field to display. Valid values are [email,humanId,id,lastModification,lastModificationLamports,login,metadata,name] - -h, --help help for user + -f, --format string Select the output formatting style. Valid values are [default,json] (default "default") + -h, --help help for user ``` ### SEE ALSO -* [git-bug](git-bug.md) - A bug tracker embedded in Git. -* [git-bug user adopt](git-bug_user_adopt.md) - Adopt an existing identity as your own. -* [git-bug user create](git-bug_user_create.md) - Create a new identity. -* [git-bug user ls](git-bug_user_ls.md) - List identities. +* [git-bug](git-bug.md) - A bug tracker embedded in Git +* [git-bug user adopt](git-bug_user_adopt.md) - Adopt an existing identity as your own +* [git-bug user new](git-bug_user_new.md) - Create a new identity +* [git-bug user user](git-bug_user_user.md) - Display a user identity diff --git a/doc/md/git-bug_user_adopt.md b/doc/md/git-bug_user_adopt.md index 87d1305f0..85a447ca4 100644 --- a/doc/md/git-bug_user_adopt.md +++ b/doc/md/git-bug_user_adopt.md @@ -1,9 +1,9 @@ ## git-bug user adopt -Adopt an existing identity as your own. +Adopt an existing identity as your own ``` -git-bug user adopt USER-ID [flags] +git-bug user adopt USER_ID [flags] ``` ### Options @@ -14,5 +14,5 @@ git-bug user adopt USER-ID [flags] ### SEE ALSO -* [git-bug user](git-bug_user.md) - Display or change the user identity. +* [git-bug user](git-bug_user.md) - List identities diff --git a/doc/md/git-bug_user_ls.md b/doc/md/git-bug_user_ls.md deleted file mode 100644 index d86263e32..000000000 --- a/doc/md/git-bug_user_ls.md +++ /dev/null @@ -1,19 +0,0 @@ -## git-bug user ls - -List identities. - -``` -git-bug user ls [flags] -``` - -### Options - -``` - -f, --format string Select the output formatting style. Valid values are [default,json] (default "default") - -h, --help help for ls -``` - -### SEE ALSO - -* [git-bug user](git-bug_user.md) - Display or change the user identity. - diff --git a/doc/md/git-bug_user_create.md b/doc/md/git-bug_user_new.md index 68fc2c0e0..f9c5ed410 100644 --- a/doc/md/git-bug_user_create.md +++ b/doc/md/git-bug_user_new.md @@ -1,9 +1,9 @@ -## git-bug user create +## git-bug user new -Create a new identity. +Create a new identity ``` -git-bug user create [flags] +git-bug user new [flags] ``` ### Options @@ -11,12 +11,12 @@ git-bug user create [flags] ``` -a, --avatar string Avatar URL -e, --email string Email of the user - -h, --help help for create + -h, --help help for new -n, --name string Name to identify the user --non-interactive Do not ask for user input ``` ### SEE ALSO -* [git-bug user](git-bug_user.md) - Display or change the user identity. +* [git-bug user](git-bug_user.md) - List identities diff --git a/doc/md/git-bug_user_user.md b/doc/md/git-bug_user_user.md new file mode 100644 index 000000000..b3e6ac9bb --- /dev/null +++ b/doc/md/git-bug_user_user.md @@ -0,0 +1,19 @@ +## git-bug user user + +Display a user identity + +``` +git-bug user user show [USER_ID] [flags] +``` + +### Options + +``` + -f, --field string Select field to display. Valid values are [email,humanId,id,lastModification,lastModificationLamports,login,metadata,name] + -h, --help help for user +``` + +### SEE ALSO + +* [git-bug user](git-bug_user.md) - List identities + diff --git a/doc/md/git-bug_version.md b/doc/md/git-bug_version.md index 2d1a16a95..ceba8790f 100644 --- a/doc/md/git-bug_version.md +++ b/doc/md/git-bug_version.md @@ -1,6 +1,6 @@ ## git-bug version -Show git-bug version information. +Show git-bug version information ``` git-bug version [flags] @@ -17,5 +17,5 @@ git-bug version [flags] ### SEE ALSO -* [git-bug](git-bug.md) - A bug tracker embedded in Git. +* [git-bug](git-bug.md) - A bug tracker embedded in Git diff --git a/doc/md/git-bug_webui.md b/doc/md/git-bug_webui.md index b1c54d3b5..c342a9cf3 100644 --- a/doc/md/git-bug_webui.md +++ b/doc/md/git-bug_webui.md @@ -1,6 +1,6 @@ ## git-bug webui -Launch the web UI. +Launch the web UI ### Synopsis @@ -29,5 +29,5 @@ git-bug webui [flags] ### SEE ALSO -* [git-bug](git-bug.md) - A bug tracker embedded in Git. +* [git-bug](git-bug.md) - A bug tracker embedded in Git |