USAGE:(1)

✨ NAME ✨

okay so bestie, this is the manual page for usage: — aka pyaml, your new fave lil YAML prettifier 💖 the whole invocation vibe is:

usage: pyaml [-h] [-r] [-o file-path] [-w chars] [-v N[/M][g]] [-l] [-q]

no cap, that's the whole personality right there 🎀

---

💅 DESCRIPTION 💅

okay so, the full shape of it:

usage: pyaml [-h] [-r] [-o file-path] [-w chars] [-v N[/M][g]] [-l] [-q]
       [path ...]

what it does: Process and dump prettified YAML to stdout. literally that's it, that's the whole job, and it ate 🫶

🌸 positional arguments: 🌸

• path — the path(s) to YAML you want read, bestie. if it's default/empty, it just uses stdin like a chill lil ghost 👻 and if you pass multiple paths, it'll output YAML documents from each one, in the same order. no shuffling, no chaos, order is preserved, periodt.

✨ options: ✨

• -h, --help — show this help message and exit. the classic, the icon, the one we all press first 😭
• -r, --replace — Replace specified YAML file(s) with prettified version in-place. glow-up directly on the file, no copies left behind 💅
• -o, --out-file file-path — Write output to specified file instead of standard output. like, put it somewhere specific instead of yelling it at the terminal 📁
• -w, --width chars — Max line width hint to pass to pyyaml for the dump. Only used to format scalars and collections (e.g. lists). so it's a hint, not a vibe check — it only matters for scalars and collections like lists 🧚
• -v, --vspacing N[/M][g] — Custom thresholds for when to add vertical spacing (empty lines), to visually separate items in overly long YAML lists/mappings.

"long" here means both >split-lines in line-length AND has >split-count items. the value has the N[/M][g] format, and the default is something like 40/2. lowkey a whole system but it's giving organized ✨

• N = min number of same-indent lines in a section to split.
• M = min count of values in a list/mapping to split. g can be added to clump single-line values at the top of such lists/maps. s to split all-onliner blocks of values.

values examples, fr fr: 20g, 5/1g, 60/4, gs, 10.

• -l, --lines — Read input as a list of \0 (ascii null char) or newline-separated json/yaml "lines", common with loggers or other incremental data dumps.

Each input entry will be exported as a separate YAML document (after ---). and bestie, Empty or whitespace-only input entries are skipped without errors — no drama, no complaints, it just moves on 🙈

• -q, --quiet — Disable sanity-check on the output and suppress stderr warnings. shhh mode 🤫

🦋 that awkward lil bit 🦋

[path ...]

and also, iconic behaviour:

pyaml: error: unrecognized arguments: --version

not the --version erasure 💀 there's no version flag in this lineup, so don't come for it — it will simply tell you it doesn't recognize the argument.

---

👑 SEE ALSO 👑

The full documentation for usage: is maintained as a Texinfo manual. If the info and usage: programs are properly installed at your site, the command

info usage:

should give you access to the complete manual. go read it, it's giving lore 📚

---

and that's a wrap, bestie 🎀 this page comes to you courtesy of the source/version line <code>usage: pyaml [-h] [-r] [-o file...</code> dated March 2026, manual section USAGE:(1) — she's serving documentation realness, slay 💖✨