Skip to content
ShipGate

Installation

ShipGate’s Tier‑1 path is: install the CLI → run shipgate next on pull requests in Next.js App Router repos → NO_SHIP should fail CI once you configure the job as a required check in your repo (start advisory if you prefer). Copy-paste commands (pinned): docs/quickstart.md. See also Supported path (Tier-1).

Network / data (Tier‑1): shipgate next does not send your source to ShipGate’s servers or require a ShipGate login. Other commands (scan, dashboard, opt-in analytics) have different rules — data handling.

Prerequisites

  • Node.js 18 or later
  • npm, pnpm, or yarn

Install the CLI

Install the published CLI globally (pin matches the ShipGate repo quickstart):

Terminal window
npm install -g @shipgate.dev/cli@3.0.0

Or with pnpm:

Terminal window
pnpm add -g @shipgate.dev/cli@3.0.0

Verify the installation:

Terminal window
shipgate --version

When using the published CLI you’ll use shipgate; when running from source (e.g. pnpm --filter @isl-lang/cli exec isl ...) the binary may be available as isl.

Project-level installation

For team projects, install as a dev dependency so everyone uses the same version:

Terminal window
npm install --save-dev @shipgate.dev/cli@3.0.0

Then add scripts to your package.json:

{
  "scripts": {
    "verify": "shipgate verify",
    "gate": "shipgate gate",
    "lint:isl": "shipgate lint specs/"
  }
}

Initialize a project

Run the interactive setup to create your project configuration:

Terminal window
shipgate init

This creates:

  • .shipgate.yml — project configuration
  • specs/ — directory for your ISL specification files
  • .github/workflows/shipgate.yml — CI workflow (if GitHub is detected)

For a specific template:

Terminal window
# Minimal setup (just config + one example spec)
shipgate init --template minimal


# Full setup (config, examples, CI, team policies)
shipgate init --template full


# API-focused setup (REST API specs with OpenAPI generation)
shipgate init --template api

Generate specs from existing code

If you already have source code, ShipGate can generate ISL specs from it:

Terminal window
# Generate specs from a source directory
shipgate init --from-code ./src


# Generate specs with AI enhancement (requires ANTHROPIC_API_KEY)
shipgate init --from-code ./src --ai

VS Code extension

Install the ShipGate ISL extension for syntax highlighting, inline diagnostics, and verification commands:

  1. Open VS Code
  2. Go to Extensions (Ctrl+Shift+X)
  3. Search for “ShipGate ISL”
  4. Click Install

See the VS Code extension guide for details.

What’s next?