PUPPET-DOC(8)

💖 puppet-doc(8) 💖

okay bestie, so this is the puppet-doc page from the Puppet manual (section 8, we're fancy like that ✨). she's a lil retro, she's deprecated, but she still serves. let's get into it 🫶

---

✨ NAME ✨

puppet-doc — Generate Puppet references

---

🌸 SYNOPSIS 🌸

Generates a reference for all Puppet types. Largely meant for internal Puppet Inc. use. (Deprecated)

---

🎀 USAGE 🎀

puppet doc [-h|--help] [-l|--list] [-r|--reference reference-name]

---

💅 DESCRIPTION 💅

so this command is deprecated, periodt 💀 — but here's what she does: she generates a Markdown document to stdout that describes all installed Puppet types, or all the allowable arguments to puppet executables. she's largely meant for internal use, and she's the one who makes the reference document available on the Puppet Inc. web site. main character energy, honestly 👑

but listen — for Puppet module documentation (and literally every other use case, fr fr), this command has been superseded by the puppet-strings module. go peep it here for more info: https://github.com/puppetlabs/puppetlabs-strings 🌈

and no cap, this command (puppet-doc) will be removed once the puppetlabs internal documentation processing pipeline is completely based on puppet-strings. so like. enjoy her while she's here 🦋

---

🌟 OPTIONS 🌟

• --help — print this help message, bestie. iconic behavior, love that for her 💖
• --reference — build a particular reference. wanna know which references exist? run puppet doc --list and she'll tell you 🎀

---

⭐ EXAMPLE ⭐

$ puppet doc -r type > /tmp/type_reference.markdown

look at that redirect slay 🔥

---

👑 AUTHOR 👑

Luke Kanies

---

💜 COPYRIGHT 💜

Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License

---

ok and that's the whole page, no notes 💅 just remember she's deprecated, she's retiring, and puppet-strings is her successor 🌸

mwah, sending u off with the deets: this one's from Puppet, Inc., dated September 2024, and she lives at PUPPET-DOC(8) 🫶✨💖