Quickstart

Prepare your first review from your terminal or agent. Use Node.js 22.12.0 or newer; no source checkout, global install, or npm account is required.

1. Run the CLI

npx shiplet-cli --help

Use npx shiplet-cli for Shiplet; npx shiplet is an unrelated project. See CLI setup for global installation and the full command reference.

2. Prepare your build

npx shiplet-cli prepare ./dist --name "Review build" --subdomain review-build --visibility organization --dry-run --json

Replace ./dist with your file or static build folder. Check the dry-run output, then rerun without --dry-run. Approve the browser session on the same computer. The CLI preserves folder paths and returns the review URL. Organization visibility is the safe default. View access does not grant edit access.

Use npx shiplet-cli login, npx shiplet-cli whoami, and npx shiplet-cli logout to manage the session. Later commands reuse it for two hours by default.

3. Review and collect feedback

Open the returned review URL and leave a harmless comment. Find the ticket in Feedback. Reply and update status in the browser; the CLI does not expose feedback commands yet.

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

Browser alternative

Open the Shiplet app and sign in when asked. A first-time user receives a default workspace and returns to the Prepare page. Keep Upload files selected to choose supported static files, name the artifact, choose its review subdomain, and select who can see it. Choose URL for an existing public preview.

Working with an agent

Give your agent the CLI guide, let it check the artifact with npx shiplet-cli prepare --dry-run, then approve publishing in your browser. Code Mode MCP is also supported for clients that use MCP, including API discovery and feedback automation. Follow its connection guide to use browser OAuth or supported agent registration.

Troubleshooting

Problem	Safe recovery
A file is rejected	Remove the unsupported or oversized file and prepare again.
The subdomain is unavailable	Choose another lowercase, hyphenated review name.
Publishing fails	Keep the local artifact and retry after the reported problem clears.
Access is denied	Sign in with the invited email or ask an owner for the required viewing grant.

Next: leave and manage review feedback.