render.mdx

title	ox plan render
description	CLI reference for ox plan render
sidebar_position	71

ox plan render

Render a plan to a self-contained HTML page

Synopsis

Render a plan to a self-contained HTML page.

No slug renders the plan from --file/stdin; a slug renders a saved plan with its review state. With --open on a SAVED plan, ox launches the live review loop (ox plan review) so your marks write straight back to the ledger instead of a dead-end file/clipboard export — pass --static for a read-only page. -o/--output and --artifact always write a static file.

ox plan render [slug] [flags]

Options

      --artifact        render a strictly self-contained, CSP-safe page for publishing as a Claude Code Artifact (no external fonts/scripts, no review loop; enrichment links preserved)
      --file string     plan source file when no slug is given (default: stdin, else newest ~/.claude/plans/*.md)
  -h, --help            help for render
      --open            open the rendered HTML in your browser
  -o, --output string   write the rendered HTML to this path
      --static          with --open on a saved plan, open a read-only static page instead of launching the live review loop

Options inherited from parent commands

  -c, --config string    config file path (default: .sageox/config.yaml)
      --json             output in JSON format (default: false)
      --no-interactive   disable spinners and TUI elements (auto-enabled when CI=true)
      --profile          generate CPU profile and execution trace for performance analysis (default: false)
  -q, --quiet            suppress non-error output (default: false)
  -v, --verbose          enable verbose output (default: false)

SEE ALSO

• ox plan - Work with implementation plans (enrich, render, review)