Documentation

From zero to a minted environment.

One scoped operating model across the console, CLI, API, and MCP server. Follow the workflow or jump straight to a client.

Quickstart

# install the CLInpm install --global @instaship/cli

# 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.GitHub Action ↗
What is an environment?Apps, targets, providers, and sinks: the mental model.→Your first mintA complete walkthrough, including a browser approval checkpoint.→MCP and keys for agentsConnect with OAuth or a key and limit actions, apps, and environment types.→GitHub ActionsCombine shared Preview settings with branch-specific provider credentials.→
MCP reference
https://www.instaship.app/mcpAdd this Streamable HTTP endpoint to an OAuth-capable MCP client.
OAuth 2.1 + PKCESign in, then select allowed actions, apps, and environment types on the Instaship consent screen.
Bearer ish_live_…Headless clients can use a scoped API key without a browser flow.

MCP exposes app management, manifest schemas and defaults, minting, status, environment variable-name inspection, and cleanup as native tools. It never returns environment variable values; use a scoped API key with the CLI or API when a trusted process must export them.

Guides
Default manifestsDeclare Google Workspace APIs and provider 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 apps createCreate an app from a connected GitHub repository with an app-management key.
iship apps set-manifestValidate and replace one app's default provider manifest.
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 --app <name> --branch <branch>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.