PUPPET-HELP(8)

📦
version 8.10.0 · 10 versions
, in arch rolling, fedora 43, fedora 44, nixos 26.05

💖 PUPPET-HELP(8) 💖

okay so bestie, welcome to the puppet-help manual page — yes it's section 8, yes it's from the Puppet manual, and yes we are going to get you fluent in it. buckle up 🎀

✨ NAME ✨

puppet-help — display Puppet help. that's it. that's the whole vibe. it's giving "just tell me what to type" energy 💅

🌸 SYNOPSIS 🌸

puppet help action

🦋 OPTIONS 🦋

okay first, a little heads up before we get into the flags, and this one's important so listen up 🫶

any setting that's valid in the configuration file is also a valid long argument, even if 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. no cap.

see the configuration file documentation at https://puppet.com/docs/puppet/latest/configuration.html for the full list of acceptable parameters. and lowkey? a commented list of all configuration options can also be generated by running puppet with --genconfig. slay.

  • --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. (yes girl, tell me everything 👀)
  • --debug — whether to log debug information. 🔍

👑 ACTIONS 👑

help — display help about Puppet subcommands and their actions. periodt.

SYNOPSIS

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

DESCRIPTION

display help about Puppet subcommands and their actions. main character behavior honestly 💖

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. cute, quick, done 🌈

🍓 EXAMPLES 🍓

get help for an action:

$ puppet help

that's the example. it's literally one command. iconic. 😌

Copyright 2011 by Puppet Inc. Apache 2 license; see COPYING

okay bestie that's the whole page 🎀 this manual was brought to you by Puppet, Inc. and it's dated September 2024 — so if you're reading this and it's giving ancient, check the version, mwah 💋 go forth and puppet help your way through life ✨🦋💅

📦 where this page comes from