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
Start

Quickstart

Upload an artifact and open its review link in a few minutes.

The fastest path starts in the browser.

1. Open the Prepare page

Open the Shiplet app and sign in when asked. A first-time user receives a default workspace and returns to the Prepare page.

2. Choose the work to review

Keep Upload files selected, then choose supported static files, browser media, documents, archives, source code, structured data, or GIS data. Use Code Mode MCP or direct REST when an automated build needs to preserve folder paths. Choose URL for an existing public preview.

Name the artifact, choose its review subdomain, and select who can see it. Organization is the safe default for an internal review. View access does not grant edit access.

3. Open the review link

Shiplet places the artifact inside a sandboxed frame and shows trusted review controls around it. Leave a harmless comment, then find the ticket on the Shiplet detail page or in the global Feedback view.

Read Review feedback for ticket work and Access control before sharing the link.

Optional: automate with MCP

https://shiplet.cc/api/mcp

The first protected action opens AuthKit in the browser. Code Mode MCP includes the complete setup.

Troubleshooting

ProblemSafe recovery
A file is rejectedRemove the unsupported or oversized file and prepare again.
The subdomain is unavailableChoose another lowercase, hyphenated review name.
Publishing failsKeep the local artifact and retry after the reported problem clears.
Access is deniedSign in with the invited email or ask an owner for the required viewing grant.

Next: leave and manage review feedback.