Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion cmd/scw/testdata/test-all-usage-help-usage.golden
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Get help about how the CLI works
Get help about how specific topics inside the CLI work

USAGE:
scw help <command>
Expand All @@ -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.
2 changes: 1 addition & 1 deletion cmd/scw/testdata/test-main-usage-usage.golden
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ STORAGE COMMANDS:
UTILITY COMMANDS:
autocomplete Autocomplete related commands
feedback Send feedback to the Scaleway CLI Team!
help Get help about how the CLI works
help Get help about how specific topics inside the CLI work
shell Start shell mode
version Display cli version

Expand Down
2 changes: 1 addition & 1 deletion docs/commands/help.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!-- DO NOT EDIT: this file is automatically generated using scw-doc-gen -->
# Documentation for `scw help`
Get help about how the CLI works
Get help about how specific topics inside the CLI work

- [Get help about how date parsing works in the CLI](#get-help-about-how-date-parsing-works-in-the-cli)
- [Get help about how the CLI output works](#get-help-about-how-the-cli-output-works)
Expand Down
8 changes: 7 additions & 1 deletion internal/namespaces/help/custom.go
Original file line number Diff line number Diff line change
Expand Up @@ -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 work",
Namespace: "help",
AllowAnonymousClient: true,
Groups: []string{"utility"},
SeeAlsos: []*core.SeeAlso{
{
Short: "Print general help",
Command: "scw --help",
},
},
}
}

Expand Down
Loading