Documentation

From zero to a minted environment.

One CLI and one console, governed by the same scoped access. Follow the operating model or jump straight to the commands.

Quickstart

# from the repository checkoutnpm run install:global

# authenticateiship login --key ish_live_…

# mint a branchiship mint --app Cyrus --branch feat/new-linear-scope --wait-till-done

# write its variablesiship env-file <environment-id> --file .env.local

Agents and CI use the same commands.
What is an environment?Apps, targets, providers, and sinks: the mental model.→Your first mintA complete walkthrough, including a browser approval checkpoint.→Keys for agents and CILimit actions, apps, and environment types.→
Guides
Default manifestsDeclare provider settings and route patterns once.Per-mint overridesChange one section or replace a provider manifest.Evidence and checkpointsRead ordered steps and intervene exactly where needed.Environment variables and sinksPull a local file or sync to a Vercel target.CleanupRemove branch resources without losing the audit trail.Custody and ejectionUnderstand the workspace-wide, one-way handoff.
CLI reference
iship mintCreate an environment for $0.25, or reuse its matching live environment for free.
iship environmentsList environments with their current status and target.
iship whoamiInspect the configured key's enforced actions, apps, and environment types.
iship status <environment-id>Inspect provisioning steps, errors, and approval actions.
iship env-file <environment-id> --file <path>Write the environment variables to a local file.
iship schema <provider>Read the accepted manifest shape for a provider.
iship cleanup <environment-id>Remove resources created for an environment.
iship login --key <key>Authenticate with a scoped API key.

The REST API follows the same run lifecycle and scoped access rules. Review full provisioning evidence in the Console.