@shipstatic/ship 0.9.5 → 0.9.6

package/README.md

@@ -2,23 +2,15 @@
 
 CLI and SDK for [ShipStatic](https://shipstatic.com) — deploy static websites, landing pages, and prototypes instantly from the terminal or code.
 
-## Install
+## Deploy in seconds — no install, no account
 
 ```bash
-npm install -g @shipstatic/ship
+npx @shipstatic/ship ./dist
 ```
 
-> As a project dependency: `npm install @shipstatic/ship`
-
-## Deploy — Free, No Account Needed
+That's it. Your site is live on `*.shipstatic.com`. No sign-up, no config, no global install. Got Node? You're ready.
 
-```bash
-ship ./dist
-```
-
-Your site is live instantly on `*.shipstatic.com`. No API key, no sign-up, no configuration.
-
-Deployments without an API key are public and expire in 3 days. The output includes a **claim URL** — visit it to keep the site permanently.
+The output includes a **claim URL** — visit it to keep the site permanently. Anonymous deployments are public and expire in 3 days.
 
 ```javascript
 import Ship from '@shipstatic/ship';
@@ -29,6 +21,16 @@ const result = await ship.deploy('./dist');
 // result.claim      → visit to keep permanently
 ```
 
+## Install (optional, for repeat use)
+
+```bash
+npm install -g @shipstatic/ship   # global CLI — drop the `npx @shipstatic/ship` prefix
+```
+
+> As a project dependency: `npm install @shipstatic/ship`
+>
+> Every example in this README uses the bare `ship` command. If you haven't installed it globally, prefix any of them with `npx @shipstatic/ship` (or `npx -y @shipstatic/ship` in non-interactive environments).
+
 ## All Commands — Free API Key
 
 For permanent deployments and full control over your sites and domains, get a free API key from [my.shipstatic.com/api-key](https://my.shipstatic.com/api-key).
@@ -152,20 +154,40 @@ ship completion uninstall
 
 ### Global Flags
 
+Available on every command:
+
 | Flag | Description |
 |------|-------------|
 | `--api-key <key>` | API key for authenticated requests |
 | `--deploy-token <token>` | Deploy token for single-use deployments |
+| `--api-url <url>` | API URL override (for development) |
 | `--config <file>` | Custom config file path |
-| `--label <label>` | Add label (repeatable) |
-| `--password <password>` | Password-protect this deployment |
-| `--no-path-detect` | Disable automatic path optimization |
-| `--no-spa-detect` | Disable automatic SPA detection |
-| `--no-color` | Disable colored output |
 | `--json` | Output results in JSON format |
 | `-q, --quiet` | Output only the resource identifier |
+| `--no-color` | Disable colored output |
+| `--help` | Display help for command |
 | `--version` | Show version information |
 
+### Deploy Flags
+
+Available on `ship <path>` and `ship deployments upload`:
+
+| Flag | Description |
+|------|-------------|
+| `--label <label>` | Add label (repeatable) |
+| `--password <password>` | Password-protect this deployment (6–128 chars) |
+| `--no-path-detect` | Disable automatic path optimization |
+| `--no-spa-detect` | Disable automatic SPA detection |
+
+### CLI Environment Variables
+
+| Var | Purpose |
+|---|---|
+| `SHIP_API_KEY` | Default for `--api-key` |
+| `SHIP_DEPLOY_TOKEN` | Default for `--deploy-token` |
+| `SHIP_API_URL` | Default for `--api-url` |
+| `SHIP_PASSWORD` | Default for `--password` (empty string normalized to absence) |
+
 ## SDK Reference
 
 ### Authentication
@@ -193,11 +215,13 @@ ship.deploy(input, {
   password?: string,          // Password-protect the deployment (6–128 chars)
   onProgress?: ({ percent }) => void,
   signal?: AbortSignal,
+  onCancel?: () => void,      // Called if signal aborts
   pathDetect?: boolean,       // Auto-optimize paths (default: true)
   spaDetect?: boolean,        // Auto-detect SPA (default: true)
   maxConcurrency?: number,    // Concurrent uploads (default: 4)
   timeout?: number,           // Request timeout in ms
   via?: string,               // Client identifier
+  apiUrl?: string,            // Per-request API URL override
   apiKey?: string,            // Per-request API key override
   deployToken?: string,       // Per-request deploy token override
 });

package/SKILL.md

@@ -1,7 +1,7 @@
 ---
 name: ship
 description: "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."
-compatibility: "Node.js >= 20. Install globally via npm: npm install -g @shipstatic/ship"
+compatibility: "Node.js >= 20. Run via npx (no install) or install globally: npm install -g @shipstatic/ship"
 metadata:
   openclaw:
     requires:
@@ -17,6 +17,18 @@ metadata:
 
 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
@@ -40,10 +52,12 @@ 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,
@@ -52,7 +66,7 @@ ship ./dist --json
 }
 ```
 
-`claim` and `expires` only appear without credentials. With an API key, deployments are permanent.
+`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
 
@@ -156,6 +170,7 @@ ship domains set www.example.com <dep> --json
 ```json
 {
   "domain": "www.example.com",
+  "url": "https://www.example.com",
   "deployment": "happy-cat-abc1234.shipstatic.com",
   "status": "pending",
   "labels": [],
@@ -274,5 +289,7 @@ ship tokens remove <token>            # Revoke
 | `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` |
+| `<resource> 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 |

package/dist/browser.d.ts

@@ -119,9 +119,14 @@ interface ShipClientOptions {
      * Used by orchestrators (e.g. n8n nodes processing many tenants from one
      * worker) so the API's rate-limit bucket keys per caller rather than per
      * shared IP. **Programmatic-only by design** — there is no `--caller`
-     * CLI flag because the CLI is a single-user tool (`via: 'cli'` is hardcoded
-     * in `performDeploy`); every CLI invocation belongs to one human, and
-     * a per-tenant rate-limit bucket would defeat the purpose.
+     * CLI flag because every CLI invocation belongs to one human; a per-tenant
+     * rate-limit bucket would defeat the purpose.
+     *
+     * Distinct from `via` (the client identifier — `'cli'`, `'sdk'`, `'web'`,
+     * `'git'`, etc.). `via` is for analytics/origin tracking and is
+     * env-overridable via `SHIP_VIA` for integrations that wrap the CLI
+     * (GitHub Action, MCP). `caller` is for rate-limit isolation and stays
+     * programmatic-only.
      */
     caller?: string | undefined;
     /**