Help

A good way to become familiar with all that nu has to offer is by utilizing the help command.

How to see all supported commands:

  1. > help commands | where is_custom == $false | first 10 | drop column

Output

  1. ───┬───────────────┬────────────┬───────────┬───────────┬────────────────────────────────────────────────────────────────
  2. # │ name │ category │ is_plugin │ is_custom │ usage
  3. ───┼───────────────┼────────────┼───────────┼───────────┼────────────────────────────────────────────────────────────────
  4. 0 alias core false false Alias a command (with optional flags) to a new name
  5. 1 all? filters false false Test if every element of the input matches a predicate.
  6. 2 ansi platform false false Output ANSI codes to change color.
  7. 3 ansi gradient platform false false draw text with a provided start and end code making a gradient
  8. 4 ansi strip platform false false strip ansi escape sequences from string
  9. 5 any? filters false false Tests if any element of the input matches a predicate.
  10. 6 append filters false false Append a row to the table.
  11. 7 benchmark system false false Time the running time of a block
  12. 8 build-string strings false false Create a string from the arguments.
  13. 9 cal generators false false Display a calendar.
  14. ───┴───────────────┴────────────┴───────────┴───────────┴────────────────────────────────────────────────────────────────

Specific information on a command

To find more specific information on a command, use help <COMMAND>.

  1. > help fetch

Output

  1. Fetch the contents from a URL (HTTP GET operation).
  2. Usage:
  3. > fetch {flags} <URL>
  4. Flags:
  5. -h, --help
  6. Display this help message
  7. -u, --user <Any>
  8. the username when authenticating
  9. -p, --password <Any>
  10. the password when authenticating
  11. -t, --timeout <Int>
  12. timeout period in seconds
  13. -H, --headers <Any>
  14. custom headers you want to add
  15. -r, --raw
  16. fetch contents as text rather than a table
  17. Parameters:
  18. URL: the URL to fetch the contents from
  19. Examples:
  20. Fetch content from url.com
  21. > fetch url.com
  22. Fetch content from url.com, with username and password
  23. > fetch -u myuser -p mypass url.com
  24. Fetch content from url.com, with custom header
  25. > fetch -H [my-header-key my-header-value] url.com

Specific information on a command subcommand

To find more specific information on a command subcommand, use help <COMMAND> <SUBCOMMAND>.

  1. > help str reverse

Output

  1. outputs the reversals of the strings in the pipeline
  2. Usage:
  3. > str reverse ...(rest)
  4. Flags:
  5. -h, --help
  6. Display this help message
  7. Parameters:
  8. ...rest: optionally reverse text by column paths
  9. Examples:
  10. Return the reversals of multiple strings
  11. > 'Nushell' | str reverse