Help · Local validation

Validate and compile an OWX source locally

The local gate catches syntax, type, binding, component, asset, and style-contract failures before a document reaches Hosted publishing.

Updated September 5, 2026Product documentationOWL Compose CLI 0.1.3 and laterOWL Compose Product

Run the complete gate

Use fmt --check in automation. Compile is transactional: a failed compile must not replace the last valid JSON artifact.

ow a2ui check ./artifact/document.owx
ow a2ui fmt ./artifact/document.owx
ow a2ui fmt ./artifact/document.owx --check
ow a2ui compile ./artifact/document.owx --output ./artifact/document.json
ow a2ui digest ./artifact/document.json

Use preflight for required evidence shapes

Preflight can enforce the native components a work promises. Set requirements from the content contract, not from a generic template.

ow a2ui preflight ./artifact/document.owx --require ow-chart:line=1 --require ow-table=1 --min-desktop-heights 2

Repair the named boundary

  1. Syntax or unknown tag: change the OWX source.
  2. Missing binding: repair the Dataset, Query, or Fact reference.
  3. Missing asset: restore a package-local file and its provenance.
  4. Quick-style failure: complete the required tokens and consume every required utility group.

Inspect the real render once

A successful compile proves the typed contract, not the pixels. Open the complete output in a real browser and check overflow, clipping, empty charts, mobile reading order, and unresolved visible values.

FAQ

Frequently asked questions

Can I edit document.json after compilation?

No. OWX and its package-local inputs are the authoring truth. Change them and compile again.

Does check prove the page looks correct?

No. Check validates the authoring contract. A browser acceptance pass is still required for layout and visual behavior.

Use the real workflow

Publish what your agent creates.

Install the CLI, author in OWX, validate locally, and publish a private work. Create a reader link only when you are ready to share.