Skip to content

add custom help command information #2015

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 22, 2025
Merged

add custom help command information #2015

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
03d48f0
add custom help to docs
Tyarel8 Aug 22, 2025
975bff2
specify -> create
Tyarel8 Aug 22, 2025
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: 6 additions & 0 deletions cookbook/help.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,3 +53,9 @@ help http get
# => http get content from example.com, with custom header
# => > http get -H [my-header-key my-header-value] https://www.example.com
```

### Custom help command
If you want to change the `help` output, you can create your own custom command named `help` and it will also be used for all `--help` invocations. An example of this is in the standard library.
```nu
use std/help
```