Man Page: puppet help

NOTE: This page was generated from the Puppet source code on 2022-02-07 10:05:17 -0800


puppet-help - Display Puppet help.


puppet help action


Note that any setting that's valid in the configuration file is also a valid long argument, although it may or may not be relevant to the present action. For example, server and run_mode are valid settings, so you can specify --server <servername>, or --run_mode <runmode> as an argument.

See the configuration file documentation at for the full list of acceptable parameters. A commented list of all configuration options can also be generated by running puppet with --genconfig.

--render-as FORMAT

The format in which to render output. The most common formats are json, s (string), yaml, and console, but other options such as dot are sometimes available.


Whether to log verbosely.


Whether to log debug information.


help - Display help about Puppet subcommands and their actions.


puppet help [--version VERSION] [--ronn] [subcommand] [action]


Display help about Puppet subcommands and their actions.

OPTIONS --ronn - Whether to render the help text in ronn format.

--version VERSION - The version of the subcommand for which to show help.


Short help text for the specified subcommand or action.



Get help for an action:

$ puppet help