pyaml - Man Page

manual page for usage: pyaml [-h] [-r] [-w chars] [-v N[/M][g]] [-l] [-q] [path]

Description

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

Process and dump prettified YAML to stdout.

positional arguments

path

Path to YAML to read (default: use stdin).

options

-h, --help

show this help message and exit

-r, --replace

Replace specified path with prettified version in-place.

-w, --width chars

Max line width hint to pass to pyyaml for the dump. Only used to format scalars and collections (e.g. 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" means both >split-lines in line-length and has >split-count items. Value has N[/M][g] format, with default being something like 40/2.

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: 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 "---").

Empty or whitespace-only input entries are skipped without errors.

-q, --quiet

Disable sanity-check on the output and suppress stderr warnings.

pyaml: error: unrecognized arguments: --version

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.

Info

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