Skip to content
vizzy vizzy

The vizzy CLI

The Vizzy app ships a vizzy command line tool — the same engine as the app, no window required. It does three things:

  • Render any .vizzy.md to images (PNG, JPEG, TIFF, HEIC, AVIF) — the piece that lets a coding agent author a diagram and drop the image straight into your repo.
  • Lint files for problems the renderer silently ignores — broken links, unsupported HTML, stray edges — so you can gate CI on it.
  • Drive the running app — focus a node, jump to a document, open a hint, or read what a window is showing, so an agent can navigate the canvas with you.

Install the command line tool

Section titled “Install the command line tool”

The CLI lives inside the app, so install the vizzy launcher once:

Vizzy ▸ Install Command Line Tool…

This adds vizzy to /usr/local/bin (you may be asked for your password if that folder needs admin rights). Confirm it worked:

Terminal window
vizzy --help
vizzy version      # print the installed version

The launcher stays pointed at the app automatically — each time you open Vizzy it re-links the installed vizzy to the running app, so moving the app or taking an update keeps the command working without re-installing.

Open the app from the terminal

Section titled “Open the app from the terminal”

Run vizzy with no subcommand to open the current folder, or pass paths to open specific files or folders:

Terminal window
vizzy                       # open the current directory in Vizzy
vizzy ~/Code/myproject      # open a folder
vizzy vizzy/auth.vizzy.md   # open a single diagram file

This reuses a running instance, focusing the existing window rather than launching a second copy.

Where to next

Section titled “Where to next”