Shiproom CLI

Install

Install it globally, or run any command through npx:

npm install --global shiproom
shiproom version

Every command below also works as npx shiproom@latest <command> if you would rather not install anything.

Start a private review session

Start your app as usual, then run Shiproom from the same folder:

npm run dev
shiproom live

The first run opens a secure browser sign-in. Shiproom then detects a responding loopback HTTP application, creates or reuses the project for the current folder, and prints the review link once the session is actually live.

shiproom live --port 3000
shiproom live --project "Acme checkout"
shiproom live --no-feedback
shiproom live --replace

--project names a project only when Shiproom creates a new one for the folder; it never renames a linked project. --no-feedback disables the feedback widget for the session. On a new project it also sets that project's stored default; on a reused project it does not change the stored default for later sessions.

Port selection prefers --port, then PORT, then responding local listeners, then common development ports, then an interactive prompt. Shiproom only connects to loopback and does not support --host.

Reviewer access

Reviewers need no Shiproom account and install nothing. Projects are private by default. Treat each invite link as access-bearing and share it only with intended reviewers.

shiproom access status
shiproom invites list
shiproom invites rotate <id>
shiproom invites revoke <id>

A session is offline when the app, the CLI, the computer or the internet connection is unavailable. The review link is not a permanent URL.

Manage sessions and feedback

shiproom status
shiproom stop
shiproom stop --all
shiproom feedback list
shiproom feedback show abc12345
shiproom feedback set-status abc12345 triaged
shiproom feedback export abc12345
shiproom feedback export abc12345 --format json --out feedback.json
shiproom logout

Ctrl+C stops a session cleanly without deleting its project, invites or feedback. Exports are deterministic: Markdown goes to standard output by default, --format jsonselects JSON, and --out writes a file. Shiproom does not use a language model to produce them.

Troubleshooting

• Start the local app first, then run shiproom live --port <port>.
• If a port does not respond as HTTP on loopback, Shiproom rejects it before sign-in rather than failing later.
• Use shiproom live --replace only when you intend to take over an existing live session for that project.
• Run shiproom help or shiproom help <topic> for per-command help.

What Shiproom does not touch

Shiproom never reads or modifies your repository, source code, Git metadata or package manifest. It identifies a project from the folder path alone, and writes nothing into your application directory. It does not permanently host your application.

See the privacy overview for what a feedback report contains, and MCP documentation for the published adapter and token commands. Questions: [email protected].