SOS_HELP(1)

✨ NAME ✨

okay so meet sos_help 🎀, the General Commands Manual page that's basically your go-to for detailed sos help 💖

sos_help - get detailed help information on sos commands and components 🧚

🌸 SYNOPSIS 🌸

sos help TOPIC

💅 DESCRIPTION 💅

okay bestie, sos help is how you get the deep info on the different SoS commands and components 🔥 It's way more detailed than what you'll find in other manpages or --help output, so it's giving main character energy 👑

like, say you want to investigate a specific plugin 🦋 to learn its purpose, use case, collections, available plugin options, edge cases, and more. this is literally the move ✨

and ngl, pretty much every part of how SoS operates can be looked into this way 🌈 That includes the top level functions like report, clean, and collect 💜, plus the constructs that make those functions work. for example, transports within sos collect define how that function connects to remote nodes 🫶

🎀 REQUIRED ARGUMENTS 🎀

TOPIC

this is the section or topic you want detailed help for 💖 TOPIC looks like command.component.entity, where the component and entity bits are optional 🍓

top-level command help sections will often point you to component sections, and those might point to even more entity subsections. it's like a little scavenger hunt 🧚

here are some of the most iconic and useful sections:

• report — the sos report command 💅
• report.plugins — information on what report plugins are 🦋
• report.plugins.$plugin — information on a specific plugin 🔥
• clean or mask — the sos clean|mask command ✨
• collect — the sos collect command 💜
• collect.clusters — how collect enumerates nodes in a cluster 🌈
• policies — how SoS behaves on different distributions 👑

Sign-off: this has been your Unix bestie, SOS_HELP(1) 🫶 as of Fri Nov 05 2021, stay iconic and read the manual, periodt 💀✨