# ShipStatic

> Static hosting on a global edge network. Deploy instantly. Free, no account needed. Claim to keep permanently.

The platform has two primitives: **deployments** (immutable file snapshots with instant preview URLs) and **domains** (pointers you repoint between deployments for instant rollbacks).

Publishing is free and needs no account. What each plan adds is under [Plans](https://docs.shipstatic.com/plans.md); current prices are on the [pricing page](https://www.shipstatic.com/pricing), and programs read them live from `GET https://api.shipstatic.com/plans`.

The docs are written for agents too: every page at `docs.shipstatic.com` is also plain markdown at its address plus `.md`, and the index under Docs below links those copies.

## If you are an agent, start here

One command is the whole integration. No account, no key, no config, and it works in a fresh sandbox:

```bash
npx -y @shipstatic/ship ./dist --json
```

- **Point it at BUILT OUTPUT** (`./dist`, `./build`, `./out`), never a project root. Build first if the project needs it.
- **`--json` answers in JSON either way**: the result on stdout, or the error on stderr with a non-zero exit code. Branch on the error's `error` and `status`, never on its message text; the tags are listed under Errors in the [API docs](https://docs.shipstatic.com/api.md).
- **Always show the user both URLs from the response**: `url` (live now) and `claim`. The claim URL is the only way the site outlives its 3 days, and it is shown once: nothing can recover it later.
- Set `SHIP_TOKEN` when deploys should land in the user's account and never expire. It takes their API key or a deploy token; one slot takes either.

Speak MCP instead? Add `https://mcp.shipstatic.com` to the client and call `deployments_upload`: same rules, nothing to install. To publish a folder on the user's own machine, `npx -y @shipstatic/mcp` runs the same tools locally.

## Agent resources

- [ShipStatic for agents](https://www.shipstatic.com/agents/): every way an agent can publish, on one page
- [SKILL.md](https://www.shipstatic.com/SKILL.md): a skill file that teaches an agent to publish through the CLI
- [.well-known/mcp.json](https://www.shipstatic.com/.well-known/mcp.json): MCP server discovery

## Docs

- [Quickstart](https://docs.shipstatic.com/quickstart.md): Publish a site in about a minute with no account, keep it with the claim link, then put it on your own domain.

## Concepts

- [Deployments](https://docs.shipstatic.com/deployments.md): Immutable snapshots of static files, each with its own URL: properties, lifecycle, limits, public deploys and claiming, passwords, labels and origin tags.
- [Domains](https://docs.shipstatic.com/domains.md): Give a deployment a permanent address: ShipStatic domains, custom domains and the personal setup instructions that connect them, domain status, and switching deployments for instant rollbacks.
- [Tokens](https://docs.shipstatic.com/tokens.md): Deploy tokens: scoped, revocable credentials for CI and automation, with an optional lifetime and IP lock, that never expose your API key.
- [API Key](https://docs.shipstatic.com/api-key.md): Your account's persistent credential: its format, where to find it, and how to pass it to the CLI, SDK, MCP server and API.
- [ship.json](https://docs.shipstatic.com/ship-json.md): Optional configuration for how a deployment is served: clean URLs, trailing slashes, redirects, rewrites, headers, their processing order and limits.
- [Plans](https://docs.shipstatic.com/plans.md): What each plan is for, from publishing with no account to paid plans with custom domains, and where to read current prices and caps.

## Interfaces

- [Web Console](https://docs.shipstatic.com/web.md): The dashboard at my.shipstatic.com: drag-and-drop publishing, building from source, deployments, domains and DNS setup, tokens and your account.
- [CLI](https://docs.shipstatic.com/cli.md): Publish from a terminal, or from any agent that can run one, with a single npx command and no account, then manage deployments, domains and tokens.
- [MCP](https://docs.shipstatic.com/mcp.md): One URL for any MCP client: tools to publish sites and manage domains, with nothing to install and no account needed to deploy.
- [SDK](https://docs.shipstatic.com/sdk.md): Publish and manage sites from Node.js or the browser: the client, deploy options, every resource method, events, errors and pagination.
- [GitHub Action](https://docs.shipstatic.com/action.md): A GitHub Action that publishes on every push, with PR previews, custom domains and deployments that clean themselves up.
- [Agent Skill](https://docs.shipstatic.com/skill.md): One SKILL.md file that teaches any AI coding agent to publish and manage sites through the CLI.
- [API](https://docs.shipstatic.com/api.md): The REST API behind every interface: authentication, endpoints, upload formats, status codes, error tags, pagination, rate limits and idempotent deploys.
- [Gemini CLI](https://docs.shipstatic.com/gemini.md): A Gemini CLI extension that publishes folders from your own machine through the ShipStatic MCP server, with or without an account.
- [VS Code](https://docs.shipstatic.com/vs-code.md): A VS Code extension that gives agent mode the ShipStatic tools and adds palette commands to publish the folder you are working in.
- [n8n Node](https://docs.shipstatic.com/n8n.md): A community node that publishes sites from any n8n workflow, callable by an n8n AI Agent as a tool, with no account needed.

## Optional

- [llms-full.txt](https://www.shipstatic.com/llms-full.txt): every page above, in full, in one file