cargo-help(1)

NAME

cargo-help --- Get help for a Cargo command

SYNOPSIS

cargo help [subcommand]

DESCRIPTION

Prints a help message for the given command.

For commands with subcommands, separate the command levels with spaces. For example, cargo help report future-incompatibilities displays help for the cargo report future-incompatibilities command.

Spaces separate hierarchy levels only between a parent command and its subcommands. Dashes that are part of a command's name, such as generate-lockfile, must always be preserved.

Multiple command levels can also be written as a single dash-joined word. For example, cargo help report-future-incompatibilities is equivalent to cargo help report future-incompatibilities.

OPTIONS

Display Options

{{#options}} {{> options-display }} {{/options}}

Manifest Options

{{#options}} {{> options-locked }} {{/options}}

{{> section-options-common }}

{{> section-environment }}

{{> section-exit-status }}

EXAMPLES

1. Get help for a command:

   Copy

   cargo help build
   

2. Get help for a nested command:

   Copy

   cargo help report future-incompatibilities
   

3. The dash-joined form also works:

   Copy

   cargo help report-future-incompatibilities
   

4. Help is also available with the --help flag:

   Copy

   cargo build --help
   

SEE ALSO

{{man "cargo" 1}}