From bf72fc4e16c882a860ef5ecd6cb09c921e2cfd99 Mon Sep 17 00:00:00 2001 From: Katrin Leinweber Date: Thu, 25 Apr 2024 08:08:18 +0200 Subject: [PATCH 1/5] Avoid errors: unknown command "help" for "glab ..." sd --fixed-strings ' help [' ' --help [' docs/**/*.md --- docs/source/alias/help.md | 2 +- docs/source/ask/help.md | 2 +- docs/source/auth/help.md | 2 +- docs/source/changelog/help.md | 2 +- docs/source/ci/help.md | 2 +- docs/source/cluster/help.md | 2 +- docs/source/config/help.md | 2 +- docs/source/incident/help.md | 2 +- docs/source/issue/help.md | 2 +- docs/source/job/help.md | 2 +- docs/source/label/help.md | 2 +- docs/source/mr/help.md | 2 +- docs/source/release/help.md | 2 +- docs/source/repo/help.md | 2 +- docs/source/schedule/help.md | 2 +- docs/source/snippet/help.md | 2 +- docs/source/ssh-key/help.md | 2 +- docs/source/user/help.md | 2 +- docs/source/variable/help.md | 2 +- 19 files changed, 19 insertions(+), 19 deletions(-) diff --git a/docs/source/alias/help.md b/docs/source/alias/help.md index ebfe4a08a..e7ed39a92 100644 --- a/docs/source/alias/help.md +++ b/docs/source/alias/help.md @@ -14,7 +14,7 @@ Please do not edit this file directly. Run `make gen-docs` instead. Help about any command ```plaintext -glab alias help [command] [flags] +glab alias --help [command] [flags] ``` ## Options inherited from parent commands diff --git a/docs/source/ask/help.md b/docs/source/ask/help.md index 9072abe87..abd889696 100644 --- a/docs/source/ask/help.md +++ b/docs/source/ask/help.md @@ -14,7 +14,7 @@ Please do not edit this file directly. Run `make gen-docs` instead. Help about any command ```plaintext -glab ask help [command] [flags] +glab ask --help [command] [flags] ``` ## Options inherited from parent commands diff --git a/docs/source/auth/help.md b/docs/source/auth/help.md index 3839b0b4f..0d9a01784 100644 --- a/docs/source/auth/help.md +++ b/docs/source/auth/help.md @@ -14,7 +14,7 @@ Please do not edit this file directly. Run `make gen-docs` instead. Help about any command ```plaintext -glab auth help [command] [flags] +glab auth --help [command] [flags] ``` ## Options inherited from parent commands diff --git a/docs/source/changelog/help.md b/docs/source/changelog/help.md index 8345bbab3..cf295dd44 100644 --- a/docs/source/changelog/help.md +++ b/docs/source/changelog/help.md @@ -14,7 +14,7 @@ Please do not edit this file directly. Run `make gen-docs` instead. Help about any command ```plaintext -glab changelog help [command] [flags] +glab changelog --help [command] [flags] ``` ## Options inherited from parent commands diff --git a/docs/source/ci/help.md b/docs/source/ci/help.md index f46fb8221..b6bc991fa 100644 --- a/docs/source/ci/help.md +++ b/docs/source/ci/help.md @@ -14,7 +14,7 @@ Please do not edit this file directly. Run `make gen-docs` instead. Help about any command ```plaintext -glab ci help [command] [flags] +glab ci --help [command] [flags] ``` ## Options inherited from parent commands diff --git a/docs/source/cluster/help.md b/docs/source/cluster/help.md index 09254616b..19cdcf954 100644 --- a/docs/source/cluster/help.md +++ b/docs/source/cluster/help.md @@ -14,7 +14,7 @@ Please do not edit this file directly. Run `make gen-docs` instead. Help about any command ```plaintext -glab cluster help [command] [flags] +glab cluster --help [command] [flags] ``` ## Options inherited from parent commands diff --git a/docs/source/config/help.md b/docs/source/config/help.md index 73095c3ac..33378a527 100644 --- a/docs/source/config/help.md +++ b/docs/source/config/help.md @@ -14,7 +14,7 @@ Please do not edit this file directly. Run `make gen-docs` instead. Help about any command ```plaintext -glab config help [command] [flags] +glab config --help [command] [flags] ``` ## Options inherited from parent commands diff --git a/docs/source/incident/help.md b/docs/source/incident/help.md index 5045ef25b..80e24ec8b 100644 --- a/docs/source/incident/help.md +++ b/docs/source/incident/help.md @@ -14,7 +14,7 @@ Please do not edit this file directly. Run `make gen-docs` instead. Help about any command ```plaintext -glab incident help [command] [flags] +glab incident --help [command] [flags] ``` ## Options inherited from parent commands diff --git a/docs/source/issue/help.md b/docs/source/issue/help.md index 3c60d3e82..73f8de93c 100644 --- a/docs/source/issue/help.md +++ b/docs/source/issue/help.md @@ -14,7 +14,7 @@ Please do not edit this file directly. Run `make gen-docs` instead. Help about any command ```plaintext -glab issue help [command] [flags] +glab issue --help [command] [flags] ``` ## Options inherited from parent commands diff --git a/docs/source/job/help.md b/docs/source/job/help.md index cec25262f..0759dfbff 100644 --- a/docs/source/job/help.md +++ b/docs/source/job/help.md @@ -14,7 +14,7 @@ Please do not edit this file directly. Run `make gen-docs` instead. Help about any command ```plaintext -glab job help [command] [flags] +glab job --help [command] [flags] ``` ## Options inherited from parent commands diff --git a/docs/source/label/help.md b/docs/source/label/help.md index 8a379cebe..03451278f 100644 --- a/docs/source/label/help.md +++ b/docs/source/label/help.md @@ -14,7 +14,7 @@ Please do not edit this file directly. Run `make gen-docs` instead. Help about any command ```plaintext -glab label help [command] [flags] +glab label --help [command] [flags] ``` ## Options inherited from parent commands diff --git a/docs/source/mr/help.md b/docs/source/mr/help.md index 7b5fa05d3..894f5d8b6 100644 --- a/docs/source/mr/help.md +++ b/docs/source/mr/help.md @@ -14,7 +14,7 @@ Please do not edit this file directly. Run `make gen-docs` instead. Help about any command ```plaintext -glab mr help [command] [flags] +glab mr --help [command] [flags] ``` ## Options inherited from parent commands diff --git a/docs/source/release/help.md b/docs/source/release/help.md index b3f8880da..0bc8cd3df 100644 --- a/docs/source/release/help.md +++ b/docs/source/release/help.md @@ -14,7 +14,7 @@ Please do not edit this file directly. Run `make gen-docs` instead. Help about any command ```plaintext -glab release help [command] [flags] +glab release --help [command] [flags] ``` ## Options inherited from parent commands diff --git a/docs/source/repo/help.md b/docs/source/repo/help.md index cf12513c7..7dadc4e7c 100644 --- a/docs/source/repo/help.md +++ b/docs/source/repo/help.md @@ -14,7 +14,7 @@ Please do not edit this file directly. Run `make gen-docs` instead. Help about any command ```plaintext -glab repo help [command] [flags] +glab repo --help [command] [flags] ``` ## Options inherited from parent commands diff --git a/docs/source/schedule/help.md b/docs/source/schedule/help.md index 86228ebd4..0f41bb32e 100644 --- a/docs/source/schedule/help.md +++ b/docs/source/schedule/help.md @@ -14,7 +14,7 @@ Please do not edit this file directly. Run `make gen-docs` instead. Help about any command ```plaintext -glab schedule help [command] [flags] +glab schedule --help [command] [flags] ``` ## Options inherited from parent commands diff --git a/docs/source/snippet/help.md b/docs/source/snippet/help.md index bfea171b2..93ed6c9e8 100644 --- a/docs/source/snippet/help.md +++ b/docs/source/snippet/help.md @@ -14,7 +14,7 @@ Please do not edit this file directly. Run `make gen-docs` instead. Help about any command ```plaintext -glab snippet help [command] [flags] +glab snippet --help [command] [flags] ``` ## Options inherited from parent commands diff --git a/docs/source/ssh-key/help.md b/docs/source/ssh-key/help.md index 063a68496..7344bfad1 100644 --- a/docs/source/ssh-key/help.md +++ b/docs/source/ssh-key/help.md @@ -14,7 +14,7 @@ Please do not edit this file directly. Run `make gen-docs` instead. Help about any command ```plaintext -glab ssh-key help [command] [flags] +glab ssh-key --help [command] [flags] ``` ## Options inherited from parent commands diff --git a/docs/source/user/help.md b/docs/source/user/help.md index ac1c7ffec..c93946be3 100644 --- a/docs/source/user/help.md +++ b/docs/source/user/help.md @@ -14,7 +14,7 @@ Please do not edit this file directly. Run `make gen-docs` instead. Help about any command ```plaintext -glab user help [command] [flags] +glab user --help [command] [flags] ``` ## Options inherited from parent commands diff --git a/docs/source/variable/help.md b/docs/source/variable/help.md index 8924e4677..623b99fcb 100644 --- a/docs/source/variable/help.md +++ b/docs/source/variable/help.md @@ -14,7 +14,7 @@ Please do not edit this file directly. Run `make gen-docs` instead. Help about any command ```plaintext -glab variable help [command] [flags] +glab variable --help [command] [flags] ``` ## Options inherited from parent commands -- GitLab From 9437dfa6411f137b5fcbadb50292585b8c884973 Mon Sep 17 00:00:00 2001 From: Katrin Leinweber Date: Thu, 25 Apr 2024 08:15:38 +0200 Subject: [PATCH 2/5] Turn "... --help" flags into "help ..." commands sd ' (\w+) --help' ' help $1 ' docs/**/*.md --- docs/source/alias/help.md | 2 +- docs/source/ask/help.md | 2 +- docs/source/auth/help.md | 2 +- docs/source/changelog/help.md | 2 +- docs/source/ci/help.md | 2 +- docs/source/cluster/help.md | 2 +- docs/source/config/help.md | 2 +- docs/source/incident/help.md | 2 +- docs/source/issue/help.md | 2 +- docs/source/job/help.md | 2 +- docs/source/label/help.md | 2 +- docs/source/mr/help.md | 2 +- docs/source/release/help.md | 2 +- docs/source/repo/help.md | 2 +- docs/source/schedule/help.md | 2 +- docs/source/snippet/help.md | 2 +- docs/source/user/help.md | 2 +- docs/source/variable/help.md | 2 +- 18 files changed, 18 insertions(+), 18 deletions(-) diff --git a/docs/source/alias/help.md b/docs/source/alias/help.md index e7ed39a92..92d0056b6 100644 --- a/docs/source/alias/help.md +++ b/docs/source/alias/help.md @@ -14,7 +14,7 @@ Please do not edit this file directly. Run `make gen-docs` instead. 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 abd889696..44d1240c9 100644 --- a/docs/source/ask/help.md +++ b/docs/source/ask/help.md @@ -14,7 +14,7 @@ Please do not edit this file directly. Run `make gen-docs` instead. 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 0d9a01784..b8338eb01 100644 --- a/docs/source/auth/help.md +++ b/docs/source/auth/help.md @@ -14,7 +14,7 @@ Please do not edit this file directly. Run `make gen-docs` instead. 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 cf295dd44..b89bd15db 100644 --- a/docs/source/changelog/help.md +++ b/docs/source/changelog/help.md @@ -14,7 +14,7 @@ Please do not edit this file directly. Run `make gen-docs` instead. 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 b6bc991fa..06851da6e 100644 --- a/docs/source/ci/help.md +++ b/docs/source/ci/help.md @@ -14,7 +14,7 @@ Please do not edit this file directly. Run `make gen-docs` instead. 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 19cdcf954..9a9a4780d 100644 --- a/docs/source/cluster/help.md +++ b/docs/source/cluster/help.md @@ -14,7 +14,7 @@ Please do not edit this file directly. Run `make gen-docs` instead. 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 33378a527..cd50a03a8 100644 --- a/docs/source/config/help.md +++ b/docs/source/config/help.md @@ -14,7 +14,7 @@ Please do not edit this file directly. Run `make gen-docs` instead. 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 80e24ec8b..eb42f704d 100644 --- a/docs/source/incident/help.md +++ b/docs/source/incident/help.md @@ -14,7 +14,7 @@ Please do not edit this file directly. Run `make gen-docs` instead. 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/issue/help.md b/docs/source/issue/help.md index 73f8de93c..d68fcf7a5 100644 --- a/docs/source/issue/help.md +++ b/docs/source/issue/help.md @@ -14,7 +14,7 @@ Please do not edit this file directly. Run `make gen-docs` instead. 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 0759dfbff..c333eddee 100644 --- a/docs/source/job/help.md +++ b/docs/source/job/help.md @@ -14,7 +14,7 @@ Please do not edit this file directly. Run `make gen-docs` instead. 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 03451278f..37253fabb 100644 --- a/docs/source/label/help.md +++ b/docs/source/label/help.md @@ -14,7 +14,7 @@ Please do not edit this file directly. Run `make gen-docs` instead. 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 894f5d8b6..13d963e0a 100644 --- a/docs/source/mr/help.md +++ b/docs/source/mr/help.md @@ -14,7 +14,7 @@ Please do not edit this file directly. Run `make gen-docs` instead. 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 0bc8cd3df..79e4d7d7a 100644 --- a/docs/source/release/help.md +++ b/docs/source/release/help.md @@ -14,7 +14,7 @@ Please do not edit this file directly. Run `make gen-docs` instead. 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 7dadc4e7c..39092cc71 100644 --- a/docs/source/repo/help.md +++ b/docs/source/repo/help.md @@ -14,7 +14,7 @@ Please do not edit this file directly. Run `make gen-docs` instead. 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 0f41bb32e..bf70d5959 100644 --- a/docs/source/schedule/help.md +++ b/docs/source/schedule/help.md @@ -14,7 +14,7 @@ Please do not edit this file directly. Run `make gen-docs` instead. 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 93ed6c9e8..a94dc4571 100644 --- a/docs/source/snippet/help.md +++ b/docs/source/snippet/help.md @@ -14,7 +14,7 @@ Please do not edit this file directly. Run `make gen-docs` instead. 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/user/help.md b/docs/source/user/help.md index c93946be3..c1c1c56b2 100644 --- a/docs/source/user/help.md +++ b/docs/source/user/help.md @@ -14,7 +14,7 @@ Please do not edit this file directly. Run `make gen-docs` instead. 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 623b99fcb..bbddcd723 100644 --- a/docs/source/variable/help.md +++ b/docs/source/variable/help.md @@ -14,7 +14,7 @@ Please do not edit this file directly. Run `make gen-docs` instead. Help about any command ```plaintext -glab variable --help [command] [flags] +glab help variable [command] [flags] ``` ## Options inherited from parent commands -- GitLab From d3c8abb617ef98e04ca7db92fd36f1e99d4e1aa6 Mon Sep 17 00:00:00 2001 From: Katrin Leinweber Date: Thu, 25 Apr 2024 08:33:55 +0200 Subject: [PATCH 3/5] Also update code snippets in H1s --- docs/source/alias/help.md | 2 +- docs/source/ask/help.md | 2 +- docs/source/auth/help.md | 2 +- docs/source/changelog/help.md | 2 +- docs/source/ci/help.md | 2 +- docs/source/cluster/help.md | 2 +- docs/source/config/help.md | 2 +- docs/source/incident/help.md | 2 +- docs/source/issue/help.md | 2 +- docs/source/job/help.md | 2 +- docs/source/label/help.md | 2 +- docs/source/mr/help.md | 2 +- docs/source/release/help.md | 2 +- docs/source/repo/help.md | 2 +- docs/source/schedule/help.md | 2 +- docs/source/snippet/help.md | 2 +- docs/source/ssh-key/help.md | 2 +- docs/source/user/help.md | 2 +- docs/source/variable/help.md | 2 +- 19 files changed, 19 insertions(+), 19 deletions(-) diff --git a/docs/source/alias/help.md b/docs/source/alias/help.md index 92d0056b6..252faac57 100644 --- a/docs/source/alias/help.md +++ b/docs/source/alias/help.md @@ -9,7 +9,7 @@ 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 diff --git a/docs/source/ask/help.md b/docs/source/ask/help.md index 44d1240c9..8804a33f3 100644 --- a/docs/source/ask/help.md +++ b/docs/source/ask/help.md @@ -9,7 +9,7 @@ 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 diff --git a/docs/source/auth/help.md b/docs/source/auth/help.md index b8338eb01..31b84c084 100644 --- a/docs/source/auth/help.md +++ b/docs/source/auth/help.md @@ -9,7 +9,7 @@ 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 diff --git a/docs/source/changelog/help.md b/docs/source/changelog/help.md index b89bd15db..3f9fd3d45 100644 --- a/docs/source/changelog/help.md +++ b/docs/source/changelog/help.md @@ -9,7 +9,7 @@ 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 diff --git a/docs/source/ci/help.md b/docs/source/ci/help.md index 06851da6e..8445fc092 100644 --- a/docs/source/ci/help.md +++ b/docs/source/ci/help.md @@ -9,7 +9,7 @@ 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 diff --git a/docs/source/cluster/help.md b/docs/source/cluster/help.md index 9a9a4780d..b8a19c225 100644 --- a/docs/source/cluster/help.md +++ b/docs/source/cluster/help.md @@ -9,7 +9,7 @@ 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 diff --git a/docs/source/config/help.md b/docs/source/config/help.md index cd50a03a8..9b0a5d825 100644 --- a/docs/source/config/help.md +++ b/docs/source/config/help.md @@ -9,7 +9,7 @@ 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 diff --git a/docs/source/incident/help.md b/docs/source/incident/help.md index eb42f704d..8212ad111 100644 --- a/docs/source/incident/help.md +++ b/docs/source/incident/help.md @@ -9,7 +9,7 @@ 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 diff --git a/docs/source/issue/help.md b/docs/source/issue/help.md index d68fcf7a5..c5cbe9e17 100644 --- a/docs/source/issue/help.md +++ b/docs/source/issue/help.md @@ -9,7 +9,7 @@ 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 diff --git a/docs/source/job/help.md b/docs/source/job/help.md index c333eddee..7c14382e4 100644 --- a/docs/source/job/help.md +++ b/docs/source/job/help.md @@ -9,7 +9,7 @@ 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 diff --git a/docs/source/label/help.md b/docs/source/label/help.md index 37253fabb..be82c5603 100644 --- a/docs/source/label/help.md +++ b/docs/source/label/help.md @@ -9,7 +9,7 @@ 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 diff --git a/docs/source/mr/help.md b/docs/source/mr/help.md index 13d963e0a..235e88742 100644 --- a/docs/source/mr/help.md +++ b/docs/source/mr/help.md @@ -9,7 +9,7 @@ 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 diff --git a/docs/source/release/help.md b/docs/source/release/help.md index 79e4d7d7a..dbba27a72 100644 --- a/docs/source/release/help.md +++ b/docs/source/release/help.md @@ -9,7 +9,7 @@ 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 diff --git a/docs/source/repo/help.md b/docs/source/repo/help.md index 39092cc71..b9369cbb9 100644 --- a/docs/source/repo/help.md +++ b/docs/source/repo/help.md @@ -9,7 +9,7 @@ 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 diff --git a/docs/source/schedule/help.md b/docs/source/schedule/help.md index bf70d5959..d227fb9a5 100644 --- a/docs/source/schedule/help.md +++ b/docs/source/schedule/help.md @@ -9,7 +9,7 @@ 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 diff --git a/docs/source/snippet/help.md b/docs/source/snippet/help.md index a94dc4571..7cb394c2a 100644 --- a/docs/source/snippet/help.md +++ b/docs/source/snippet/help.md @@ -9,7 +9,7 @@ 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 diff --git a/docs/source/ssh-key/help.md b/docs/source/ssh-key/help.md index 7344bfad1..59ad71619 100644 --- a/docs/source/ssh-key/help.md +++ b/docs/source/ssh-key/help.md @@ -9,7 +9,7 @@ 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 ssh-help key` Help about any command diff --git a/docs/source/user/help.md b/docs/source/user/help.md index c1c1c56b2..4b33dce17 100644 --- a/docs/source/user/help.md +++ b/docs/source/user/help.md @@ -9,7 +9,7 @@ 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 diff --git a/docs/source/variable/help.md b/docs/source/variable/help.md index bbddcd723..dd3e19172 100644 --- a/docs/source/variable/help.md +++ b/docs/source/variable/help.md @@ -9,7 +9,7 @@ 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 -- GitLab From 4a0bb4ce0010aaa465842a9111ef08bd891dc3a1 Mon Sep 17 00:00:00 2001 From: Katrin Leinweber Date: Thu, 25 Apr 2024 08:51:54 +0200 Subject: [PATCH 4/5] Fix ssh-key example due to incomplete regex in 9437dfa6 --- docs/source/ssh-key/help.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/ssh-key/help.md b/docs/source/ssh-key/help.md index 59ad71619..622ba38dc 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-help key` +# `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 -- GitLab From 4a6d79ded639b53374f5fa1ba9871c1797894220 Mon Sep 17 00:00:00 2001 From: Katrin Leinweber Date: Thu, 25 Apr 2024 08:53:44 +0200 Subject: [PATCH 5/5] Document "help" command and "--help" flag --- docs/source/index.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/source/index.md b/docs/source/index.md index e71afb3b1..b6e67673c 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 -- GitLab