Public docs

Shiplet documentation

Learn how to publish static previews, share review links, collect feedback, and wire feedback back into your workflow.

Workflows

Publishing

Publish static uploaded artifacts or Worker scripts.

The MVP path is static upload.

Static uploads

Static uploads are a list of files with base64 content.

Rules:

  • At least one file is required.
  • If index.html is included, Shiplet serves it as the preview entry point.
  • If no index.html is included, Shiplet generates a reviewable preview page that embeds or links the uploaded static assets.
  • Paths should be relative to the artifact root.
  • Empty files are ignored.
{
  "name": "Campaign prototype",
  "subdomain": "campaign-prototype",
  "visibility": "organization",
  "assets": [
    {
      "path": "index.html",
      "content": "PCFkb2N0eXBlIGh0bWw+PGgxPkNhbXBhaWduPC9oMT4="
    }
  ]
}

Standalone files work too:

{
  "name": "Diagram review",
  "subdomain": "diagram-review",
  "visibility": "organization",
  "assets": [
    {
      "path": "mermaid-diagram.png",
      "content": "iVBORw0KGgo..."
    }
  ]
}

Worker scripts

Worker script publishing is available when Workers for Platforms dispatch is configured.

Static uploads continue to work without dispatch access because Shiplet stores and serves files from the platform database fallback.