Help commands

nRF Util

tags
nRF Util

nRF Util comes with different levels of help options:

Command Description
-h Add to a command to display concise help for the command in the command line. For example, nrfutil device -h for the device command.
--help Add to a command to display extended help for the command in the command line. Compared with the -h command, this will display the help with some additional details.
--help-extended Add to a command to open the comprehensive help guide in your browser for the command. These quick guides are also available in this documentation.

The help text in --help and -h groups parameters as options and arguments:

  • Options are command line arguments that you specify using a --<flag>. Examples: --help, --option value.
  • Arguments are command line arguments with no preceding flag. Required arguments appear in the command invocation under the Usage description.

Tip

Help is context-sensitive. If you need usage instructions while writing a command, you can use -h and --help, regardless of any other arguments supplied. For example, the following command shows the usage instructions for nrfutil device program:

nrfutil device program --firmware firmware.hex --help