From 7c09bb4fd02e996592661911c844bbd2cd245223 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9my=20L=C3=A9one?= Date: Mon, 24 Nov 2025 15:40:20 +0100 Subject: [PATCH 1/2] docs(help): add see also for the help command --- cmd/scw/testdata/test-all-usage-help-usage.golden | 6 +++++- internal/namespaces/help/custom.go | 8 +++++++- 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/cmd/scw/testdata/test-all-usage-help-usage.golden b/cmd/scw/testdata/test-all-usage-help-usage.golden index c1cd9e4c34..3f5bb83387 100644 --- a/cmd/scw/testdata/test-all-usage-help-usage.golden +++ b/cmd/scw/testdata/test-all-usage-help-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Get help about how the CLI works +Get help about how specific topics inside the CLI USAGE: scw help @@ -18,4 +18,8 @@ GLOBAL FLAGS: -o, --output string Output format: json or human, see 'scw help output' for more info (default "human") -p, --profile string The config profile to use +SEE ALSO: + # Print general help + scw --help + Use "scw help [command] --help" for more information about a command. diff --git a/internal/namespaces/help/custom.go b/internal/namespaces/help/custom.go index 4a2c35161a..58f253808d 100644 --- a/internal/namespaces/help/custom.go +++ b/internal/namespaces/help/custom.go @@ -17,10 +17,16 @@ func GetCommands() *core.Commands { func helpRoot() *core.Command { return &core.Command{ - Short: "Get help about how the CLI works", + Short: "Get help about how specific topics inside the CLI", Namespace: "help", AllowAnonymousClient: true, Groups: []string{"utility"}, + SeeAlsos: []*core.SeeAlso{ + { + Short: "Print general help", + Command: "scw --help", + }, + }, } } From 21cf6a56d4874f0b2f90db2b450c14d134f30dea Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9my=20L=C3=A9one?= Date: Mon, 24 Nov 2025 15:46:17 +0100 Subject: [PATCH 2/2] fix grammar --- cmd/scw/testdata/test-all-usage-help-usage.golden | 2 +- internal/namespaces/help/custom.go | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/cmd/scw/testdata/test-all-usage-help-usage.golden b/cmd/scw/testdata/test-all-usage-help-usage.golden index 3f5bb83387..f06e7964ff 100644 --- a/cmd/scw/testdata/test-all-usage-help-usage.golden +++ b/cmd/scw/testdata/test-all-usage-help-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Get help about how specific topics inside the CLI +Get help about how specific topics inside the CLI work USAGE: scw help diff --git a/internal/namespaces/help/custom.go b/internal/namespaces/help/custom.go index 58f253808d..6fc33c00cd 100644 --- a/internal/namespaces/help/custom.go +++ b/internal/namespaces/help/custom.go @@ -17,7 +17,7 @@ func GetCommands() *core.Commands { func helpRoot() *core.Command { return &core.Command{ - Short: "Get help about how specific topics inside the CLI", + Short: "Get help about how specific topics inside the CLI work", Namespace: "help", AllowAnonymousClient: true, Groups: []string{"utility"},