# ox viz (https://sageox.ai/docs/cli/viz)

# 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>
  <TerminalCommand>ox viz [id] [command]</TerminalCommand>
</Terminal>

## Subcommands

| Command | Description |
|---------|-------------|
| `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 pr` | Prepare a GitHub-compatible visualization for a pull request |

## Examples

<Terminal>
  <TerminalCommand>ox viz</TerminalCommand>
</Terminal>

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

<Terminal>
  <TerminalCommand>ox viz suggest "how a request flows through the auth middleware"</TerminalCommand>
</Terminal>

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

<Terminal>
  <TerminalCommand>ox viz render decision-matrix --data matrix.json</TerminalCommand>
</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>
  <TerminalCommand>ox viz lint fragment.svg</TerminalCommand>
</Terminal>

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

<Terminal>
  <TerminalCommand>ox viz pr --intent "why the queue depth spiked"</TerminalCommand>
</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](/docs/cli/plan) - Plans auto-embed visualizations when rendered
- [ox pr](/docs/cli/pr) - Pair a review visualization with a PR header