diff --git a/docs/source/alias/help.rst b/docs/source/alias/help.rst new file mode 100644 index 00000000..e3d17bb0 --- /dev/null +++ b/docs/source/alias/help.rst @@ -0,0 +1,25 @@ +.. _glab_alias_help: + +glab alias help +--------------- + +Help about any command + +Synopsis +~~~~~~~~ + + +Help provides help for any command in the application. +Simply type alias help [path to command] for full details. + +:: + + glab alias help [command] [flags] + +Options inherited from parent commands +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:: + + --help Show help for command + diff --git a/docs/source/auth/help.rst b/docs/source/auth/help.rst new file mode 100644 index 00000000..949b7790 --- /dev/null +++ b/docs/source/auth/help.rst @@ -0,0 +1,25 @@ +.. _glab_auth_help: + +glab auth help +-------------- + +Help about any command + +Synopsis +~~~~~~~~ + + +Help provides help for any command in the application. +Simply type auth help [path to command] for full details. + +:: + + glab auth help [command] [flags] + +Options inherited from parent commands +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:: + + --help Show help for command + diff --git a/docs/source/config/help.rst b/docs/source/config/help.rst new file mode 100644 index 00000000..b195dd36 --- /dev/null +++ b/docs/source/config/help.rst @@ -0,0 +1,25 @@ +.. _glab_config_help: + +glab config help +---------------- + +Help about any command + +Synopsis +~~~~~~~~ + + +Help provides help for any command in the application. +Simply type config help [path to command] for full details. + +:: + + glab config help [command] [flags] + +Options inherited from parent commands +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:: + + --help Show help for command + diff --git a/docs/source/issue/help.rst b/docs/source/issue/help.rst new file mode 100644 index 00000000..1f1135d2 --- /dev/null +++ b/docs/source/issue/help.rst @@ -0,0 +1,26 @@ +.. _glab_issue_help: + +glab issue help +--------------- + +Help about any command + +Synopsis +~~~~~~~~ + + +Help provides help for any command in the application. +Simply type issue help [path to command] for full details. + +:: + + glab issue help [command] [flags] + +Options inherited from parent commands +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:: + + --help Show help for command + -R, --repo OWNER/REPO Select another repository using the OWNER/REPO or `GROUP/NAMESPACE/REPO` format or the project ID or full URL + diff --git a/docs/source/label/help.rst b/docs/source/label/help.rst new file mode 100644 index 00000000..e72805b5 --- /dev/null +++ b/docs/source/label/help.rst @@ -0,0 +1,26 @@ +.. _glab_label_help: + +glab label help +--------------- + +Help about any command + +Synopsis +~~~~~~~~ + + +Help provides help for any command in the application. +Simply type label help [path to command] for full details. + +:: + + glab label help [command] [flags] + +Options inherited from parent commands +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:: + + --help Show help for command + -R, --repo OWNER/REPO Select another repository using the OWNER/REPO or `GROUP/NAMESPACE/REPO` format or the project ID or full URL + diff --git a/docs/source/mr/approvers.rst b/docs/source/mr/approvers.rst index 97acab18..5acc9d91 100644 --- a/docs/source/mr/approvers.rst +++ b/docs/source/mr/approvers.rst @@ -13,7 +13,7 @@ List merge request eligible approvers :: - glab mr approvers [flags] + glab mr approvers [ | ] [flags] Options inherited from parent commands ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/source/mr/checkout.rst b/docs/source/mr/checkout.rst index 0225d2bc..002b6381 100644 --- a/docs/source/mr/checkout.rst +++ b/docs/source/mr/checkout.rst @@ -13,7 +13,7 @@ Checkout to an open merge request :: - glab mr checkout [flags] + glab mr checkout [flags] Options ~~~~~~~ diff --git a/docs/source/mr/close.rst b/docs/source/mr/close.rst index dd160f3d..a1da1116 100644 --- a/docs/source/mr/close.rst +++ b/docs/source/mr/close.rst @@ -13,7 +13,7 @@ Close merge requests :: - glab mr close [flags] + glab mr close [ | ] [flags] Options inherited from parent commands ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/source/mr/delete.rst b/docs/source/mr/delete.rst index 70abd3ef..07aeb24c 100644 --- a/docs/source/mr/delete.rst +++ b/docs/source/mr/delete.rst @@ -13,7 +13,7 @@ Delete merge requests :: - glab mr delete [flags] + glab mr delete [ | ] [flags] Examples ~~~~~~~~ diff --git a/docs/source/mr/diff.rst b/docs/source/mr/diff.rst new file mode 100644 index 00000000..5a5a9101 --- /dev/null +++ b/docs/source/mr/diff.rst @@ -0,0 +1,32 @@ +.. _glab_mr_diff: + +glab mr diff +------------ + +View changes in a merge request + +Synopsis +~~~~~~~~ + + +View changes in a merge request + +:: + + glab mr diff [ | ] [flags] + +Options +~~~~~~~ + +:: + + --color string Use color in diff output: {always|never|auto} (default "auto") + +Options inherited from parent commands +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:: + + --help Show help for command + -R, --repo OWNER/REPO Select another repository using the OWNER/REPO or `GROUP/NAMESPACE/REPO` format or the project ID or full URL + diff --git a/docs/source/mr/help.rst b/docs/source/mr/help.rst new file mode 100644 index 00000000..66738a9b --- /dev/null +++ b/docs/source/mr/help.rst @@ -0,0 +1,26 @@ +.. _glab_mr_help: + +glab mr help +------------ + +Help about any command + +Synopsis +~~~~~~~~ + + +Help provides help for any command in the application. +Simply type mr help [path to command] for full details. + +:: + + glab mr help [command] [flags] + +Options inherited from parent commands +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:: + + --help Show help for command + -R, --repo OWNER/REPO Select another repository using the OWNER/REPO or `GROUP/NAMESPACE/REPO` format or the project ID or full URL + diff --git a/docs/source/mr/index.rst b/docs/source/mr/index.rst index 48277705..b67dc8ef 100755 --- a/docs/source/mr/index.rst +++ b/docs/source/mr/index.rst @@ -37,6 +37,7 @@ Subcommands close create delete + diff for issues list diff --git a/docs/source/mr/issues.rst b/docs/source/mr/issues.rst index 8a7c9786..c249743a 100644 --- a/docs/source/mr/issues.rst +++ b/docs/source/mr/issues.rst @@ -13,7 +13,7 @@ Get issues related to a particular merge request. :: - glab mr issues [flags] + glab mr issues [ | ] [flags] Examples ~~~~~~~~ diff --git a/docs/source/mr/note.rst b/docs/source/mr/note.rst index 17c72eeb..d371da35 100644 --- a/docs/source/mr/note.rst +++ b/docs/source/mr/note.rst @@ -13,7 +13,7 @@ Add a comment or note to merge request :: - glab mr note [flags] + glab mr note [ | ] [flags] Options ~~~~~~~ diff --git a/docs/source/mr/rebase.rst b/docs/source/mr/rebase.rst index 7b490c80..311e79a0 100644 --- a/docs/source/mr/rebase.rst +++ b/docs/source/mr/rebase.rst @@ -13,7 +13,7 @@ If you don’t have permissions to push to the merge request’s source branch - :: - glab mr rebase [flags] + glab mr rebase [ | ] [flags] Options inherited from parent commands ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/source/mr/reopen.rst b/docs/source/mr/reopen.rst index 62a41628..65e8be9d 100644 --- a/docs/source/mr/reopen.rst +++ b/docs/source/mr/reopen.rst @@ -13,7 +13,7 @@ Reopen merge requests :: - glab mr reopen [flags] + glab mr reopen [ | ] [flags] Options inherited from parent commands ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/source/mr/revoke.rst b/docs/source/mr/revoke.rst index d42a6cfa..add9c19b 100644 --- a/docs/source/mr/revoke.rst +++ b/docs/source/mr/revoke.rst @@ -13,7 +13,7 @@ Revoke approval on a merge request :: - glab mr revoke [flags] + glab mr revoke [ | ] [flags] Options inherited from parent commands ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/source/mr/subscribe.rst b/docs/source/mr/subscribe.rst index e8582743..aba5d43f 100644 --- a/docs/source/mr/subscribe.rst +++ b/docs/source/mr/subscribe.rst @@ -13,7 +13,7 @@ Subscribe to merge requests :: - glab mr subscribe [flags] + glab mr subscribe [ | ] [flags] Options inherited from parent commands ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/source/mr/todo.rst b/docs/source/mr/todo.rst index 4742c890..613b2417 100644 --- a/docs/source/mr/todo.rst +++ b/docs/source/mr/todo.rst @@ -13,7 +13,7 @@ Add a ToDo to merge request :: - glab mr todo [flags] + glab mr todo [ | ] [flags] Options inherited from parent commands ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/source/mr/unsubscribe.rst b/docs/source/mr/unsubscribe.rst index 061103cf..cd621861 100644 --- a/docs/source/mr/unsubscribe.rst +++ b/docs/source/mr/unsubscribe.rst @@ -13,7 +13,7 @@ Unsubscribe from merge requests :: - glab mr unsubscribe [flags] + glab mr unsubscribe [ | ] [flags] Options inherited from parent commands ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/source/mr/update.rst b/docs/source/mr/update.rst index fa3053e4..5e07a545 100644 --- a/docs/source/mr/update.rst +++ b/docs/source/mr/update.rst @@ -13,7 +13,7 @@ Update merge requests :: - glab mr update [flags] + glab mr update [ | ] [flags] Examples ~~~~~~~~ diff --git a/docs/source/pipeline/help.rst b/docs/source/pipeline/help.rst new file mode 100644 index 00000000..9de64010 --- /dev/null +++ b/docs/source/pipeline/help.rst @@ -0,0 +1,26 @@ +.. _glab_pipeline_help: + +glab pipeline help +------------------ + +Help about any command + +Synopsis +~~~~~~~~ + + +Help provides help for any command in the application. +Simply type pipeline help [path to command] for full details. + +:: + + glab pipeline help [command] [flags] + +Options inherited from parent commands +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:: + + --help Show help for command + -R, --repo OWNER/REPO Select another repository using the OWNER/REPO or `GROUP/NAMESPACE/REPO` format or the project ID or full URL + diff --git a/docs/source/release/help.rst b/docs/source/release/help.rst new file mode 100644 index 00000000..00029a55 --- /dev/null +++ b/docs/source/release/help.rst @@ -0,0 +1,26 @@ +.. _glab_release_help: + +glab release help +----------------- + +Help about any command + +Synopsis +~~~~~~~~ + + +Help provides help for any command in the application. +Simply type release help [path to command] for full details. + +:: + + glab release help [command] [flags] + +Options inherited from parent commands +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:: + + --help Show help for command + -R, --repo OWNER/REPO Select another repository using the OWNER/REPO or `GROUP/NAMESPACE/REPO` format or the project ID or full URL + diff --git a/docs/source/repo/help.rst b/docs/source/repo/help.rst new file mode 100644 index 00000000..6ec79ee4 --- /dev/null +++ b/docs/source/repo/help.rst @@ -0,0 +1,25 @@ +.. _glab_repo_help: + +glab repo help +-------------- + +Help about any command + +Synopsis +~~~~~~~~ + + +Help provides help for any command in the application. +Simply type repo help [path to command] for full details. + +:: + + glab repo help [command] [flags] + +Options inherited from parent commands +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:: + + --help Show help for command +