extern/nushell
1
0
Fork 1
mirror of https://github.com/nushell/nushell.git synced 2025-08-16 09:28:32 +02:00
Code Issues Packages Projects Releases Wiki Activity

feat(std/help): Add --help for external-commands (#15962)

Browse Source 
# Description
I have just discovered the `std/help` command and that it can use `man`
or other programs for externals. Coming from windows, I don't have `man`
so what I want is just to run `external_program --help` in most cases.
This pr adds that option, if you set `$env.NU_HELPER = "--help"`, it
will run the command you passed with `--help` added as the last
argument.


![image](https://github.com/user-attachments/assets/60d25dda-718b-4cb5-b540-808de000b221)

# User-Facing Changes
None

# Tests + Formatting


# After Submitting
This commit is contained in:
Tyarel8
2025-06-20 12:06:27 +02:00
committed by GitHub
parent 1d032ce80c
commit d9d022733f
1 changed files with 11 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
crates/nu-std/std/help/mod.nu
View File

@ -759,9 +759,13 @@ def scope-commands [
def external-commands [ def external-commands [
...command: string@"nu-complete list-commands", ...command: string@"nu-complete list-commands",
] { ] {
let target_command = $command | str join " " let target_command = $command | str join " " | str replace "^" ""
print $"(ansi default_italic)Help pages from external command ($target_command | pretty-cmd):(ansi reset)" print $"(ansi default_italic)Help pages from external command ($target_command | pretty-cmd):(ansi reset)"
^($env.NU_HELPER? | default "man") $target_command if $env.NU_HELPER? == "--help" {
run-external ($target_command | split row " ") "--help"
} else {
^($env.NU_HELPER? | default "man") $target_command
}
} }
# Show help on commands. # Show help on commands.
@ -784,6 +788,11 @@ def pretty-cmd [] {
# Display help information about different parts of Nushell. # Display help information about different parts of Nushell.
# #
# `help word` searches for "word" in commands, aliases and modules, in that order. # `help word` searches for "word" in commands, aliases and modules, in that order.
# If not found as internal to nushell, you can set `$env.NU_HELPER` to a program
# (default: man) and "word" will be passed as the first argument.
# Alternatively, you can set `$env.NU_HELPER` to `--help` and it will run "word" as
# an external and pass `--help` as the last argument (this could cause unintended
# behaviour if it doesn't support the flag, use it carefully).
# #
# Examples: # Examples:
# show help for single command, alias, or module # show help for single command, alias, or module