diff --git a/docs/source/alias/help.md b/docs/source/alias/help.md index ebfe4a08af253229ca86479db65c4d8aafca5a44..252faac57456a4d6c75feaf72bdbc761e41f0976 100644 --- a/docs/source/alias/help.md +++ b/docs/source/alias/help.md @@ -9,12 +9,12 @@ This documentation is auto generated by a script. Please do not edit this file directly. Run `make gen-docs` instead. --> -# `glab alias help` +# `glab help alias` Help about any command ```plaintext -glab alias help [command] [flags] +glab help alias [command] [flags] ``` ## Options inherited from parent commands diff --git a/docs/source/ask/help.md b/docs/source/ask/help.md index 9072abe876d9f541e78d969804c9b4fbde17763f..8804a33f3f29aeacda717c3bc337b6a023ce48b2 100644 --- a/docs/source/ask/help.md +++ b/docs/source/ask/help.md @@ -9,12 +9,12 @@ This documentation is auto generated by a script. Please do not edit this file directly. Run `make gen-docs` instead. --> -# `glab ask help` +# `glab help ask` Help about any command ```plaintext -glab ask help [command] [flags] +glab help ask [command] [flags] ``` ## Options inherited from parent commands diff --git a/docs/source/auth/help.md b/docs/source/auth/help.md index 3839b0b4f4989f126374291fe71f5cbd7888374a..31b84c084efe7dcfd7026caf4b543060b009ca4f 100644 --- a/docs/source/auth/help.md +++ b/docs/source/auth/help.md @@ -9,12 +9,12 @@ This documentation is auto generated by a script. Please do not edit this file directly. Run `make gen-docs` instead. --> -# `glab auth help` +# `glab help auth` Help about any command ```plaintext -glab auth help [command] [flags] +glab help auth [command] [flags] ``` ## Options inherited from parent commands diff --git a/docs/source/changelog/help.md b/docs/source/changelog/help.md index 8345bbab311d7df88f5f256486475e4fa5c18571..3f9fd3d45f4c0f591b2a0f6a0011e1f71c0b19f2 100644 --- a/docs/source/changelog/help.md +++ b/docs/source/changelog/help.md @@ -9,12 +9,12 @@ This documentation is auto generated by a script. Please do not edit this file directly. Run `make gen-docs` instead. --> -# `glab changelog help` +# `glab help changelog` Help about any command ```plaintext -glab changelog help [command] [flags] +glab help changelog [command] [flags] ``` ## Options inherited from parent commands diff --git a/docs/source/ci/help.md b/docs/source/ci/help.md index f46fb8221a5349bf1a92690f6759ebfea8743d34..8445fc092c88324d6d60355c0f77e63d256bb12b 100644 --- a/docs/source/ci/help.md +++ b/docs/source/ci/help.md @@ -9,12 +9,12 @@ This documentation is auto generated by a script. Please do not edit this file directly. Run `make gen-docs` instead. --> -# `glab ci help` +# `glab help ci` Help about any command ```plaintext -glab ci help [command] [flags] +glab help ci [command] [flags] ``` ## Options inherited from parent commands diff --git a/docs/source/cluster/help.md b/docs/source/cluster/help.md index 09254616bf027d0c3dbc760e75a3061072f1eef0..b8a19c2250d426253bb0522bc809faad52cb827c 100644 --- a/docs/source/cluster/help.md +++ b/docs/source/cluster/help.md @@ -9,12 +9,12 @@ This documentation is auto generated by a script. Please do not edit this file directly. Run `make gen-docs` instead. --> -# `glab cluster help` +# `glab help cluster` Help about any command ```plaintext -glab cluster help [command] [flags] +glab help cluster [command] [flags] ``` ## Options inherited from parent commands diff --git a/docs/source/config/help.md b/docs/source/config/help.md index 73095c3ac66d77f6dbfc38a603d53bec607930dd..9b0a5d825cfb522c67804700a663856adff425d0 100644 --- a/docs/source/config/help.md +++ b/docs/source/config/help.md @@ -9,12 +9,12 @@ This documentation is auto generated by a script. Please do not edit this file directly. Run `make gen-docs` instead. --> -# `glab config help` +# `glab help config` Help about any command ```plaintext -glab config help [command] [flags] +glab help config [command] [flags] ``` ## Options inherited from parent commands diff --git a/docs/source/incident/help.md b/docs/source/incident/help.md index 5045ef25b0b80d3958a6af6945bab52569987775..8212ad111791b778a6fd789477534ecf9606b104 100644 --- a/docs/source/incident/help.md +++ b/docs/source/incident/help.md @@ -9,12 +9,12 @@ This documentation is auto generated by a script. Please do not edit this file directly. Run `make gen-docs` instead. --> -# `glab incident help` +# `glab help incident` Help about any command ```plaintext -glab incident help [command] [flags] +glab help incident [command] [flags] ``` ## Options inherited from parent commands diff --git a/docs/source/index.md b/docs/source/index.md index e71afb3b162b400578184ee97a425d06ce2e1969..b6e67673cc8ad116ef67b8214529eb805c9eed4e 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -62,6 +62,11 @@ glab mr merge - [`glab user`](user) - [`glab variable`](variable) +## Get help + +All core commands have a `-h`/`--help` flag, +or can be passed to the `glab help ...` command. + ## Install the CLI Installation instructions are available in the GLab diff --git a/docs/source/issue/help.md b/docs/source/issue/help.md index 3c60d3e8272b2200cacd0e817166e5925b350f9e..c5cbe9e17fd29734015f3f89187ac866754125c8 100644 --- a/docs/source/issue/help.md +++ b/docs/source/issue/help.md @@ -9,12 +9,12 @@ This documentation is auto generated by a script. Please do not edit this file directly. Run `make gen-docs` instead. --> -# `glab issue help` +# `glab help issue` Help about any command ```plaintext -glab issue help [command] [flags] +glab help issue [command] [flags] ``` ## Options inherited from parent commands diff --git a/docs/source/job/help.md b/docs/source/job/help.md index cec25262fa7de3b59a4b2c85513d8259d2b6d289..7c14382e4d64310f0aec88da420249df979ef542 100644 --- a/docs/source/job/help.md +++ b/docs/source/job/help.md @@ -9,12 +9,12 @@ This documentation is auto generated by a script. Please do not edit this file directly. Run `make gen-docs` instead. --> -# `glab job help` +# `glab help job` Help about any command ```plaintext -glab job help [command] [flags] +glab help job [command] [flags] ``` ## Options inherited from parent commands diff --git a/docs/source/label/help.md b/docs/source/label/help.md index 8a379cebeb22cfabf77bc4ac3c054029e31b89c4..be82c5603ed0d404da036c78b66674534bac1dd0 100644 --- a/docs/source/label/help.md +++ b/docs/source/label/help.md @@ -9,12 +9,12 @@ This documentation is auto generated by a script. Please do not edit this file directly. Run `make gen-docs` instead. --> -# `glab label help` +# `glab help label` Help about any command ```plaintext -glab label help [command] [flags] +glab help label [command] [flags] ``` ## Options inherited from parent commands diff --git a/docs/source/mr/help.md b/docs/source/mr/help.md index 7b5fa05d366f17c151bbc340af7fa9a07d09e407..235e88742a75ce0f70cba627a252454bc3baa1bf 100644 --- a/docs/source/mr/help.md +++ b/docs/source/mr/help.md @@ -9,12 +9,12 @@ This documentation is auto generated by a script. Please do not edit this file directly. Run `make gen-docs` instead. --> -# `glab mr help` +# `glab help mr` Help about any command ```plaintext -glab mr help [command] [flags] +glab help mr [command] [flags] ``` ## Options inherited from parent commands diff --git a/docs/source/release/help.md b/docs/source/release/help.md index b3f8880da1bef1e12596f288b8205e0e990bcfed..dbba27a72c657012002cb7110d9cc88724bc28a1 100644 --- a/docs/source/release/help.md +++ b/docs/source/release/help.md @@ -9,12 +9,12 @@ This documentation is auto generated by a script. Please do not edit this file directly. Run `make gen-docs` instead. --> -# `glab release help` +# `glab help release` Help about any command ```plaintext -glab release help [command] [flags] +glab help release [command] [flags] ``` ## Options inherited from parent commands diff --git a/docs/source/repo/help.md b/docs/source/repo/help.md index cf12513c7b4d7068b03c97e7834a6df29c86a949..b9369cbb92a288b412e33e191b39577679105f5f 100644 --- a/docs/source/repo/help.md +++ b/docs/source/repo/help.md @@ -9,12 +9,12 @@ This documentation is auto generated by a script. Please do not edit this file directly. Run `make gen-docs` instead. --> -# `glab repo help` +# `glab help repo` Help about any command ```plaintext -glab repo help [command] [flags] +glab help repo [command] [flags] ``` ## Options inherited from parent commands diff --git a/docs/source/schedule/help.md b/docs/source/schedule/help.md index 86228ebd4afafa6ce3f3d78ead0b2c563d66be3b..d227fb9a50a5269b97d733bf6c515c680d72588f 100644 --- a/docs/source/schedule/help.md +++ b/docs/source/schedule/help.md @@ -9,12 +9,12 @@ This documentation is auto generated by a script. Please do not edit this file directly. Run `make gen-docs` instead. --> -# `glab schedule help` +# `glab help schedule` Help about any command ```plaintext -glab schedule help [command] [flags] +glab help schedule [command] [flags] ``` ## Options inherited from parent commands diff --git a/docs/source/snippet/help.md b/docs/source/snippet/help.md index bfea171b26871f9f76717d3bbe374767c3660f32..7cb394c2ae39892c9495f5dc72820ce754000982 100644 --- a/docs/source/snippet/help.md +++ b/docs/source/snippet/help.md @@ -9,12 +9,12 @@ This documentation is auto generated by a script. Please do not edit this file directly. Run `make gen-docs` instead. --> -# `glab snippet help` +# `glab help snippet` Help about any command ```plaintext -glab snippet help [command] [flags] +glab help snippet [command] [flags] ``` ## Options inherited from parent commands diff --git a/docs/source/ssh-key/help.md b/docs/source/ssh-key/help.md index 063a684967e0b364222f0a4e016cbf0c7b18aef6..622ba38dc70ce8b46c1448f96bf1f5342cb6957c 100644 --- a/docs/source/ssh-key/help.md +++ b/docs/source/ssh-key/help.md @@ -9,12 +9,12 @@ This documentation is auto generated by a script. Please do not edit this file directly. Run `make gen-docs` instead. --> -# `glab ssh-key help` +# `glab help ssh-key` Help about any command ```plaintext -glab ssh-key help [command] [flags] +glab help ssh-key [command] [flags] ``` ## Options inherited from parent commands diff --git a/docs/source/user/help.md b/docs/source/user/help.md index ac1c7ffec4fff6586c7f66fae9aaeb9c50b37009..4b33dce17416b5c400ed21f6a74656cdeca7acc7 100644 --- a/docs/source/user/help.md +++ b/docs/source/user/help.md @@ -9,12 +9,12 @@ This documentation is auto generated by a script. Please do not edit this file directly. Run `make gen-docs` instead. --> -# `glab user help` +# `glab help user` Help about any command ```plaintext -glab user help [command] [flags] +glab help user [command] [flags] ``` ## Options inherited from parent commands diff --git a/docs/source/variable/help.md b/docs/source/variable/help.md index 8924e46770e2590884acb5be6782f4d0408b6f09..dd3e191723cf6ea06da446442bc9356f78a17a7c 100644 --- a/docs/source/variable/help.md +++ b/docs/source/variable/help.md @@ -9,12 +9,12 @@ This documentation is auto generated by a script. Please do not edit this file directly. Run `make gen-docs` instead. --> -# `glab variable help` +# `glab help variable` Help about any command ```plaintext -glab variable help [command] [flags] +glab help variable [command] [flags] ``` ## Options inherited from parent commands