Documentation
CLICommands

ox viz

Use a shared visualization vocabulary in plans, documentation, pull requests, reports, and design notes. All selection is deterministic and local.

Run ox viz with no argument to browse the catalog; pass an id to get its cognitive payoff, authoring recipe, and (where mature) its executable visual contract (evidence slots, canvas, composition, hierarchy, typography, routing, variants, and finishing pass).

Usage

terminal
$

Subcommands

CommandDescription
ox viz suggest <intent>Suggest visual patterns for what you need to explain
ox viz render <id>Render a parameterized visualization from JSON data
ox viz lint <file>Check a visual fragment for accessibility, portability, and editorial quality
ox viz prPrepare a GitHub-compatible visualization for a pull request

Examples

terminal
$

Browse the catalog of patterns. Pass an id (ox viz <id>) to inspect one pattern's payoff, recipe, and required data shape.

terminal
$

Rank patterns for an intent. Add --limit to cap the number of suggestions.

terminal
$

Render a parameterized pattern from JSON into an HTML/SVG fragment, ox computes the geometry, you supply only the data. Use --data - to read the JSON from stdin.

terminal
$

Check a visual fragment for accessibility, portability, and editorial quality. Add --strict to promote editorial warnings to a non-zero exit.

terminal
$

Choose and ship a review visualization without adding review-only binary files to the PR branch. ox never posts or edits a PR, GitHub's authenticated editor creates the final attachment URL when the PNG is pasted into the description or a comment.

What's next

  • ox plan - Plans auto-embed visualizations when rendered
  • ox pr - Pair a review visualization with a PR header