Help · Five-minute quickstart

Publish your first OWL Compose document

Local authoring is separate from Hosted publishing. The editable file is OWX; the file sent to OWL Compose is the compiled Render Document JSON.

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

1. Confirm the installation

Run both checks on the machine where the Agent will author the work. Doctor must report the intended Agent target as ready.

ow --version
ow agent doctor --target auto

2. Create the editable OWX source

Ask the Agent to create a package-local document.owx. This minimal source is complete enough to validate and compile; real work should choose its structure from the reader task and retained evidence.

<ow-document owx-version="1" title="Decision brief" language="en" canvas="briefing">
  <section id="overview">
    <h2>Decision</h2>
    <ow-text id="summary" title="Decision brief" title-level="1" body="State the decision, evidence, and next action." />
  </section>
</ow-document>

3. Validate and compile

Fix the OWX source when a command fails. Never patch the generated JSON to bypass validation.

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

4. Publish, inspect, and share deliberately

Sign in, publish the compiled JSON, and open the returned owner page. Ordinary works are private by default. When a reader needs access, choose Get share link, select 24h, 7d, or 30d, and create the view link. Revoke it from the Sharing tab when access should stop.

ow login
ow publish ./artifact/document.json
Product boundary

Publishing does not upload the Agent conversation or unrelated local files. Only the compiled artifact and its package-bound assets are sent.

FAQ

Frequently asked questions

Do I need a subscription to compile locally?

No. OWX authoring, validation, formatting, compilation, and digest run locally. Hosted publishing and creation of CLI/API credentials require an active subscription.

Does publish create a public reader link?

No. The work is private by default. The author creates a separate time-limited view link from the owner page when sharing is intentional.

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.