Forrest logo
back to the nmcli tool

nmcli:tldr:99a57

nmcli: Display help.
$ nmcli --help
try on your machine

The command nmcli --help is used to display a help manual or guide for the nmcli command-line tool.

nmcli is a command-line interface to manage and control NetworkManager, which is a network connection manager for Linux-based operating systems. The --help option is a common argument used with many command-line tools to display information about the tool's usage, available options, and their descriptions.

When you run nmcli --help, it will print out the help manual for nmcli in the terminal. This manual provides an overview of nmcli's capabilities, including its options and subcommands. It may contain sections such as:

  1. Usage: Provides a brief description of the tool and how to use it.
  2. Available options: Lists and describes the command-line options (e.g., --version, --debug, etc.) that can be used with nmcli.
  3. Commands: Lists the subcommands supported by nmcli, such as connection, device, wifi, etc. It provides a brief description of each subcommand and its usage.
  4. Examples: Show example commands and their output to illustrate how to use nmcli in various scenarios.
  5. Important notes: Provides additional information or cautionary points about using nmcli.

By referring to the nmcli --help output, users can understand the available functionalities of nmcli, customize their network connections, manage network devices, configure Wi-Fi settings, establish and modify network connections, and perform other network-related tasks using the command-line interface.

This explanation was created by an AI. In most cases those are correct. But please always be careful and never run a command you are not sure if it is safe.
back to the nmcli tool