OS Manuals

/usr/bin/butane

Translates human-readable Butane configs into machine-readable Ignition configs

From butane 2.28.0-r1 (enterprise-packages), captured 2026-11-08 by running butane --help (exit 0). permalink

Usage: /usr/bin/butane [options] [input-file]
Options:
  -c, --check                     check config without producing output
      --color string[="always"]   control color output: "auto", "always", or "never" (default "auto")
  -d, --files-dir string          allow embedding local files from this directory
  -h, --help                      show usage and exit
  -o, --output string             write to output file instead of stdout
  -p, --pretty                    output formatted json
  -r, --raw                       never wrap in a MachineConfig; force Ignition output
      --raw-errors                show raw errors, rather than pretty printing them
  -s, --strict                    fail on any warning
  -V, --version                   print the version and exit
      --yaml-doc-separator        prepend YAML document separator (---) to YAML output
Options (11)
OptionDescriptionSource
-c, --checkcheck config without producing outputhelp
--color string[="always"control color output: "auto", "always", or "never" (default "auto")help
-d, --files-dir stringallow embedding local files from this directoryhelp
-h, --helpshow usage and exithelp
-o, --output stringwrite to output file instead of stdouthelp
-p, --prettyoutput formatted jsonhelp
-r, --rawnever wrap in a MachineConfig;help
--raw-errorsshow raw errors, rather than pretty printing themhelp
-s, --strictfail on any warninghelp
-V, --versionprint the version and exithelp
--yaml-doc-separatorprepend YAML document separator (---) to YAML outputhelp

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.