Skip to article
Public docs

Shiplet documentation

Prepare an artifact, share its review link, and bring contextual feedback back to your team or agent.

Browse documentation
Review

Review artifacts

Prepare uploaded files or attach an existing public URL for review.

The artifact is the work being reviewed. Shiplet supplies the review link and trusted controls around it.

Uploaded files

Agents and CI jobs send base64-encoded assets. The browser Prepare page accepts supported files directly. Shiplet serves index.html when present and creates a file review page when it is absent.

{
  "name": "Campaign prototype",
  "subdomain": "campaign-prototype",
  "visibility": "organization",
  "assets": [{ "path": "index.html", "content": "...base64..." }]
}

Experimental URL previews

URL previews are read-only and may not reproduce authentication, origin-bound JavaScript, forms, maps, or live connections. For working websites, install the website widget so the page stays on its original origin.

Send external_url for an existing staging page or public preview. The proxy allows read-only GET and HEAD requests and rejects private-network destinations, unsafe redirects, and nonstandard ports. HTML and CSS use an 8 MiB in-memory fast path plus private streaming for larger documents, with a 64 MiB actual text-response safety ceiling. Large inlined CSS data, quoted custom-property values, and simple unquoted custom-property identifiers stream through that path. HTML style, srcdoc, and srcset attribute values that themselves exceed 8 MiB fail closed instead of being returned raw. The same per-attribute bound protects the HTML parser; unrelated large attributes within that bound are preserved. Larger binary assets are not subject to text rewriting.

Trusted review boundary

The review URL belongs to Shiplet. The artifact runs in a sandboxed frame, and Shiplet renders the review layer outside it. Browser sessions and reviewer authority remain in the trusted host.

Archive and delete

Archiving removes a Shiplet from the active list without deleting its feedback or access policy. Permanent delete is an irreversible action for an archived Shiplet and requires trusted confirmation.

Next: prepare a review artifact.