puppet-help - Man Page
Display Puppet help.
Synopsis
puppet help action
Options
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 https://puppet.com/docs/puppet/latest/configuration.html 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.
- --verbose
Whether to log verbosely.
- --debug
Whether to log debug information.
Actions
- help - Display help about Puppet subcommands and their actions.
puppet help [--version VERSION] [--ronn] [subcommand] [action]
DESCRIPTION
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.
RETURNS
Short help text for the specified subcommand or action.
Examples
help
Get help for an action:
$ puppet help
Copyright and License
Copyright 2011 by Puppet Inc. Apache 2 license; see COPYING