Ship SDK

Build CI/CD pipelines or your own hosting platform on top of ours. Node.js and Browser ready.

deploy.ts

import Ship from '@shipstatic/ship';

// Initialize with your API key
const ship = new Ship({ apiKey: process.env.KEY });

// Deploy directory atomically
const { url, id } = await ship.deploy('./dist');

await ship.domains.set('staging', {
  deployment: id
});

console.log(`Live at ${url}`);

TypeScript Native

Type-safe automation.

Enjoy completion, type inference, and compile-time safety for all your deployment logic.

Fully typed response objects
Isomorphic (Browser & Node)
Progress tracking & cancellation
Structured error handling

$ npm i @shipstatic/ship

Install SDK

Configuration as Code

One file. Full control.

Drop a ship.json in your project root to configure rewrites, redirects, and custom headers. No dashboard clicks, no deploy flags, just code.

SPA Rewrites

Route all paths to index.html for client-side routing.

Redirects

Permanent or temporary redirects with status codes.

Custom Headers

Set CORS, CSP, cache-control, and any other HTTP header.

Read the docs

ship.json

{
  "rewrites": [
    {
      "source": "/**",
      "destination": "/index.html"
    }
  ]
}

Ready to go live?

No extra charges, no surprise bills, nothing to maintain.

Get Started Free View on GitHub