WIREVIZ(1)

πŸ’– WIREVIZ(1) πŸ’–

User Commands ✨ WIREVIZ(1)

okay bestie, welcome to the wireviz manual page, you're gonna eat this up fr fr πŸ’…


🌸 NAME 🌸

wireviz β€” the iconic little tool that generates wire connection diagrams from YAML, no cap πŸ¦‹


✨ SYNOPSIS ✨

wireviz [OPTIONS] [FILE]...

that's it. that's the whole vibe. options, then files, periodt πŸ‘‘


πŸ’œ DESCRIPTION πŸ’œ

It parses the FILE you hand it and generates the outputs you asked for. That's literally the whole thing. You give it YAML, it gives you diagrams. main character energy honestly 🌈


πŸŽ€ OPTIONS πŸŽ€

  • -f, --format TEXT β€” Output formats (see below). The default is hpst, which is lowkey a whole mood.
  • -p, --prepend PATH β€” YAML file to prepend to the input file. Optional, bestie β€” only if you want it. 🫢
  • -o, --output-dir PATH β€” Directory to use for output files, if you want them somewhere different from the input file's directory. Not me putting outputs in a whole other folder πŸ™ˆ
  • -O, --output-name TEXT β€” File name (without extension, okurrr) to use for output files, if you want it different from the input file name.
  • -V, --version β€” Output the WireViz version and exit. Bye bye, slay πŸ’…
  • -h, --help β€” Show this message and exit. A classic, we love her.

The -f or --format option accepts a string containing one or more of the following characters, to specify which file types to output:

  • g (GV)
  • h (HTML)
  • p (PNG)
  • s (SVG)
  • t (TSV)

mix and match them however you want, bestie 🧚

heads up: this page is for WireViz 0.4.1, so if your version number says something else, don't come for me 😭

πŸ”₯ SEE ALSO πŸ”₯

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

info wireviz

should give you access to the complete manual. go get that deep lore, iykyk πŸ’–


and that's the whole page, babe πŸŽ€ this was wireviz, from February 2025, and it's giving WIREVIZ(1). mwah πŸ’‹

πŸ“¦ where this page comes from