puppet-strings(1)

💖 puppet-strings(1) 💖

okay so bestie, welcome to the General Commands Manual entry for puppet-strings — yes that's a section 1 command, we're in the big leagues now ✨

---

🎀 NAME 🎀

puppet-strings — generate Puppet documentation with YARD

---

🌸 SYNOPSIS 🌸

puppet strings <action>
puppet strings --help

---

🦋 DESCRIPTION 🦋

So the whole point, the moment, is this: you get complete, user-friendly module documentation by using Puppet Strings. no cap. 💅

Strings takes your tags and your code comments, plus the actual source code, and cooks up documentation for a module's classes, defined types, functions, tasks, plans, and resource types and providers. it's giving factory but for docs 🏭✨

And like, if you're wondering what the vibe is — Puppet Strings is based on the YARD Ruby documentation tool. iconic lineage fr fr 👑

---

💜 ACTIONS 💜

• generate — generate documentation from files. the classic. the main character 🫶
• server — runs a local documentation server for the modules in the current Puppet environment. localhost era 🌈

---

✨ OPTIONS ✨

• --format FORMAT — the rendering format to use (peep FORMATS down below 👇)
• --out — the output file when using the markdown or json formats
• --verbose — whether to log verbosely. chatty era 💬
• --debug — whether to log debug information
• --help — show the help screen. bestie behaviour honestly

---

🌷 FORMATS 🌷

the possible formats are: "markdown", "textile", "rdoc", "ruby", "text", "html", or "none". pick your fighter, no wrong answers (okay maybe "none" is a choice but we respect it) 💖

---

⭐ EXAMPLES ⭐

If you want to generate a single reference file, use something like:

$ puppet strings generate --format markdown --out REFERENCE.md

You can otherwise generate HTML documentation this way:

$ puppet strings generate

---

🧚 ADDITIONAL DOCUMENTATION 🧚

See the upstream documentation at: https://puppet.com/docs/puppet/latest/puppet_strings.html

Code examples and style guide can be found at: https://puppet.com/docs/puppet/latest/puppet_strings_style.html

---

💀 BUGS 💀

Bugs can be reported to your distribution's bug tracker or upstream at https://github.com/puppetlabs/puppet-strings/issues.

not me manifesting bug-free code but also, you know, if it happens, the link is right there 🙈

---

👑 AUTHOR 👑

Louis-Philippe Véronneau

---

anyway that's the whole page bestie, every flag, every format, every link, all of it — nothing skipped, nothing invented, that's the vibe check passed ✅

and for the sign-off: this is puppet-strings(1), dated 2024, and honestly? slay. go generate some docs. periodt. 💅✨