1PUPPET-HELP(8)                   Puppet manual                  PUPPET-HELP(8)
2
3
4

NAME

6       puppet-help - Display Puppet help.
7

SYNOPSIS

9       puppet help action
10

OPTIONS

12       Note  that any setting that´s valid in the configuration file is also a
13       valid long argument, although it may or may  not  be  relevant  to  the
14       present action. For example, server and run_mode are valid settings, so
15       you can specify --server <servername>, or --run_mode  <runmode>  as  an
16       argument.
17
18       See    the    configuration    file   documentation   at   https://pup‐
19       pet.com/docs/puppet/latest/configuration.html for the full list of  ac‐
20       ceptable  parameters. A commented list of all configuration options can
21       also be generated by running puppet with --genconfig.
22
23       --render-as FORMAT
24              The format in which to render output. The  most  common  formats
25              are  json, s (string), yaml, and console, but other options such
26              as dot are sometimes available.
27
28       --verbose
29              Whether to log verbosely.
30
31       --debug
32              Whether to log debug information.
33

ACTIONS

35       help - Display help about Puppet subcommands and their actions.
36              SYNOPSIS
37
38              puppet help [--version VERSION] [--ronn] [subcommand] [action]
39
40              DESCRIPTION
41
42              Display help about Puppet subcommands and their actions.
43
44              OPTIONS --ronn - Whether to render the help text in ronn format.
45
46              --version VERSION - The version of the subcommand for  which  to
47              show help.
48
49              RETURNS
50
51              Short help text for the specified subcommand or action.
52

EXAMPLES

54       help
55
56       Get help for an action:
57
58       $ puppet help
59

61       Copyright 2011 by Puppet Inc. Apache 2 license; see COPYING
62
63
64
65Puppet, Inc.                     October 2021                   PUPPET-HELP(8)
Impressum