# Ship

> Deploy static websites to ShipStatic. Use when the user wants to deploy a site, publish a website, upload to hosting, go live, set up a custom domain, manage deployments, or share a site URL. No account required — instant deployment. CLI (`ship`) and Node.js/browser SDK.

- **Type:** Skill
- **Install:** `agentstack add skill-shipstatic-ship-ship`
- **Verified:** Yes — security-reviewed for prompt injection and unsafe behavior
- **Seller:** [shipstatic](https://agentstack.voostack.com/s/shipstatic)
- **Installs:** 0
- **Category:** [AI & ML](https://agentstack.voostack.com/c/ai-and-ml)
- **Latest version:** 0.1.0
- **License:** MIT
- **Upstream author:** [shipstatic](https://github.com/shipstatic)
- **Source:** https://github.com/shipstatic/ship
- **Website:** https://www.shipstatic.com

## Install

```sh
agentstack add skill-shipstatic-ship-ship
```

Requires the [AgentStack CLI](https://agentstack.voostack.com/docs/cli). Works with Claude Code, Cursor, and any MCP-compatible agent.

## About

Deploy static sites. No account, no config — just ship it.

## No-install usage (recommended for agents)

You don't need to install anything. Run any command via `npx`:

```bash
npx -y @shipstatic/ship ./dist                       # deploy (shortcut)
npx -y @shipstatic/ship deployments list             # any subcommand works the same
npx -y @shipstatic/ship domains set www.example.com  # ...
```

`-y` skips the install prompt — important for non-interactive runtimes (CI, sandboxes, agent containers). Every example below uses the bare `ship` command for readability; substitute `npx -y @shipstatic/ship` if it isn't installed globally.

## Deploy

```bash
ship ./dist
```

Site is live. Output includes the URL and a claim link.

Pass a build output directory (e.g. `./dist`, `./build`, `./out`) or a single file. Ship strips the directory prefix for clean URLs — `dist/assets/app.js` serves at `/assets/app.js`. A single file keeps its name: `ship page.html` deploys as `/page.html`. Deploying a project root (contains `package.json`, `node_modules`) is rejected — build first, then deploy the output.

Without credentials, deployments are public and expire in 3 days. **Always show the user both the deployment URL and the claim link** — the claim link lets them keep the site permanently.

The deployment ID **is** the URL hostname. Use the full ID (e.g. `happy-cat-abc1234.shipstatic.com`) as the argument to all other commands. The site lives at `https://`.

### Parsing output

```bash
ship ./dist --json
```

```json
{
  "deployment": "happy-cat-abc1234.shipstatic.com",
  "url": "https://happy-cat-abc1234.shipstatic.com",
  "files": 12,
  "size": 348160,
  "status": "success",
  "config": false,
  "password": false,
  "labels": [],
  "via": "cli",
  "created": 1743552000,
  "expires": 1743811200,
  "claim": "https://my.shipstatic.com/claim/abc123"
}
```

`claim` only appears on the initial deploy without credentials. `expires` is `null` for authenticated (permanent) deploys. `config: true` indicates a `ship.json` is present in the deployment; `password: true` indicates the deployment is password-protected.

### Piping

```bash
ship ./dist -q              # → happy-cat-abc1234.shipstatic.com
```

`-q` outputs only the identifier — use it when piping or scripting.

### Labels

```bash
ship ./dist --label v1.0 --label production
```

Labels **replace all existing**, not append. Include current labels to keep them.

### Password protection

```bash
ship ./dist --password "hunter22"          # protect deployment
SHIP_PASSWORD="hunter22" ship ./dist        # via env var
```

Visitors get an unlock page until they enter the password. Length: 6–128 characters. Set per-deployment at upload time — cannot be added or changed later (deploy a new version to rotate). Works on both internal (`*.shipstatic.com`) and custom domains. **Always show the password to the user** if you set one — they need it to view the site.

### SPA routing

Ship auto-detects single-page apps from `index.html` content and configures client-side routing rewrites — all paths serve `index.html`. No action needed. Skipped if a `ship.json` config is already included in the deployment. Disable with `--no-spa-detect`.

## Authentication

Deploy works without credentials. Everything else requires an API key.

| Needs API key | No auth needed |
|---------------|----------------|
| Permanent deploys, domains, tokens, account | Deploy (public, 3-day TTL) |

```bash
export SHIP_API_KEY=          # Environment variable (best for automation)
ship --api-key  ...           # Per-command override
ship config                        # Interactive setup → ~/.shiprc (requires TTY)
```

Deploy tokens (`--deploy-token`) are scoped, revocable deploy credentials. Set a short TTL for one-shot CI/CD workflows.

Free API key: https://my.shipstatic.com/api-key

## Custom Domains

Requires an API key. Full workflow:

```bash
# 1. Validate
ship domains validate www.example.com

# 2. Deploy + link in one pipe
ship ./dist -q | ship domains set www.example.com

# 3. Show DNS records to the user
ship domains records www.example.com

# 4. After user configures DNS → verify
ship domains verify www.example.com
```

Step 2 auto-prints DNS records and a setup link in text mode. With `--json`, call `domains records` separately.

Verification is async — DNS propagation takes minutes to hours. Check status with `ship domains get  --json` and look for `"status": "success"`.

### Domain types

| Type | Example | DNS needed | Goes live |
|------|---------|------------|-----------|
| Internal | `my-site.shipstatic.com` | No | Instantly |
| Custom | `www.example.com` | CNAME + A | After DNS verified |

**No apex domains.** Always `www.example.com`, not `example.com`. The A record only redirects apex to www.

### Upsert operations

`domains set` creates if new, updates if exists:

```bash
ship domains set www.example.com                   # Reserve (no deployment yet)
ship domains set www.example.com        # Link to deployment
ship domains set www.example.com         # Switch (instant rollback)
ship domains set www.example.com --label prod       # Update labels
```

Reads deployment from stdin when piped: `ship ./dist -q | ship domains set www.example.com`

**No unlinking.** Once linked, switch deployments or delete the domain. Setting deployment to null returns 400.

### Parsing domain output

```bash
ship domains set www.example.com  --json
```

```json
{
  "domain": "www.example.com",
  "url": "https://www.example.com",
  "deployment": "happy-cat-abc1234.shipstatic.com",
  "status": "pending",
  "labels": [],
  "created": 1743552000,
  "linked": 1743552000,
  "links": 1
}
```

```bash
ship domains records www.example.com --json
```

```json
{
  "domain": "www.example.com",
  "apex": "example.com",
  "records": [
    {"type": "A", "name": "@", "value": "76.76.21.21"},
    {"type": "CNAME", "name": "www", "value": "cname.shipstatic.com"}
  ]
}
```

### DNS helpers (custom domains only)

```bash
ship domains dns www.example.com                  # Provider name
ship domains share www.example.com                # Shareable setup link
ship domains records www.example.com -q           # TYPE NAME VALUE (one per line)
```

### Validation

Exit codes as the answer:

```bash
ship domains validate www.example.com -q && echo "valid" || echo "invalid"
```

Exit 0 = valid (outputs normalized name). Exit 1 = invalid (no output).

## Output Modes

Every command supports three modes:

| Flag | Output | When to use |
|------|--------|-------------|
| *(default)* | Human-readable | Showing results to the user |
| `--json` | JSON on stdout | Parsing programmatically |
| `-q` | Identifier only | Piping between commands |

Errors go to stderr in all modes. Exit 0 = success, 1 = error.

List commands return `{"s": [...], "cursor": null, "total": N}`. `domains list` text mode omits status — use `--json` to see `pending` vs `success`.

## Commands

### Deployments

```bash
ship ./dist                          # Deploy (shortcut)
ship deployments upload        # Deploy (explicit)
ship deployments list                # List all
ship deployments get     # Details
ship deployments set     # Update labels (--label)
ship deployments remove  # Delete (async)
```

### Domains

```bash
ship domains list                     # List all
ship domains get                # Details
ship domains set  [deployment]  # Create, link, or update
ship domains validate           # Check validity (exit code)
ship domains records            # Required DNS records
ship domains dns                # DNS provider lookup
ship domains share              # Shareable setup link
ship domains verify             # Trigger DNS verification
ship domains remove             # Delete
```

### Account & Tokens

```bash
ship whoami                           # Account info
ship ping                             # Connectivity check
ship tokens create                    # New deploy token (shown once)
ship tokens create --ttl 3600         # With expiry (seconds)
ship tokens list                      # List tokens
ship tokens remove             # Revoke
```

## Flags

| Flag | Purpose |
|------|---------|
| `--json` | JSON output |
| `-q, --quiet` | Identifier only |
| `--api-key ` | API key for this command |
| `--deploy-token ` | Single-use deploy token |
| `--label ` | Set label (repeatable, replaces all) |
| `--password ` | Password-protect deployment (6–128 chars) |
| `--no-path-detect` | Skip build output auto-detection |
| `--no-spa-detect` | Skip SPA rewrite auto-configuration |
| `--no-color` | Disable colors |
| `--config ` | Custom config path |

## Errors

| Message | Cause | Fix |
|---------|-------|-----|
| `too many requests` | Rate limited | Wait, or set an API key |
| `authentication failed` | Bad credentials | Check key/token |
| `not found` | No such resource | Verify the ID/name |
| `path does not exist` | Bad deploy path | Check file/directory |
| `invalid domain name` | Not a subdomain | Use `www.example.com`, not `example.com` |
| ` limit reached` | Plan caps hit (deployments, domains) | Suggest upgrading the plan; do not retry |
| `Account has been deleted` / `Account terminated` | Account is gone | Stop; the account cannot deploy |
| `DNS information is only available for external domains` | DNS op on internal domain | Only custom domains need DNS |
| `DNS verification already requested recently` | Rate limited | Wait |

## Source & license

This open-source skill is cataloged on AgentStack and links to its original source — we do not rehost the code.

- **Author:** [shipstatic](https://github.com/shipstatic)
- **Source:** [shipstatic/ship](https://github.com/shipstatic/ship)
- **License:** MIT
- **Homepage:** https://www.shipstatic.com

Install and usage instructions live in the source repository linked above.

## Pricing

- **Free** — Free

## Security capabilities

Automated source analysis of v0.1.0 — what this tool can access:

- **Network access:** no
- **Filesystem access:** no
- **Shell / process execution:** no
- **Environment & secrets:** no
- **Dynamic code execution:** no

*"Yes" means the capability is present in the source — more access means more to trust, not that it is unsafe.*


## Versions

- **0.1.0** — security scan: passed — Imported from the upstream source.

## Links

- Listing page: https://agentstack.voostack.com/l/skill-shipstatic-ship-ship
- Seller: https://agentstack.voostack.com/s/shipstatic
- Browse the marketplace: https://agentstack.voostack.com/browse

---
Listed on AgentStack — the marketplace for AI agent skills and MCP servers. Every listing is security-reviewed. Creators keep 70%.