@shipstatic/ship 2.0.0-beta.2 → 2.0.0-beta.20

package/README.md

@@ -49,18 +49,20 @@ const ship = new Ship({ token: 'ship-...' });
 ship ./dist                                        # Deploy (shortcut)
 ship ./dist --label production --label v1.0.0      # Deploy with labels
 ship deployments list
+ship deployments list --limit 20                   # Page size; a hint shows the next cursor
+ship deployments list --cursor <cursor>            # Continue from a previous page
 ship deployments get <deployment>
 ship deployments set <deployment> --label production
-ship deployments remove <deployment>
+ship deployments delete <deployment>
 ```
 
 ```typescript
 ship.deploy(input, options?)               // Shortcut for deployments.upload()
 ship.deployments.upload(input, options?)
-ship.deployments.list()
+ship.deployments.list(options?)            // { limit?, cursor? } — response carries the next cursor
 ship.deployments.get(deployment)
 ship.deployments.set(deployment, { labels })
-ship.deployments.remove(deployment)
+ship.deployments.delete(deployment)
 ```
 
 ### Domains
@@ -70,25 +72,25 @@ ship domains set www.example.com                   # Reserve domain (no deployme
 ship domains set www.example.com <deployment>      # Link domain to deployment
 ship domains set www.example.com --label prod      # Update labels only
 ship domains get www.example.com
-ship domains list
+ship domains list                                  # --limit / --cursor paginate here too
 ship domains validate www.example.com
 ship domains verify www.example.com
 ship domains records www.example.com
 ship domains dns www.example.com
 ship domains share www.example.com
-ship domains remove www.example.com
+ship domains delete www.example.com
 ```
 
 ```typescript
 ship.domains.set(name, { deployment?, labels? })   // Upsert — create, repoint, or label
 ship.domains.get(name)
-ship.domains.list()
+ship.domains.list(options?)                 // { limit?, cursor? }
 ship.domains.validate(name)
 ship.domains.verify(name)
 ship.domains.records(name)
 ship.domains.dns(name)
 ship.domains.share(name)
-ship.domains.remove(name)
+ship.domains.delete(name)
 ```
 
 `domains.set()` is a merge-upsert — omitted fields are preserved on update, defaulted on create. Once linked, a domain cannot be unlinked (`{ deployment: null }` → 400). Switch deployments or delete the domain instead.
@@ -105,26 +107,29 @@ ship.domains.set('www.münchen.de');    // → Unicode supported
 ```bash
 ship tokens create --ttl 3600 --label ci
 ship tokens list
-ship tokens remove <token>
+ship tokens get <token>
+ship tokens delete <token>
 ```
 
 ```typescript
 ship.tokens.create({ ttl?, labels? })
 ship.tokens.list()
-ship.tokens.remove(token)
+ship.tokens.get(token)
+ship.tokens.delete(token)
 ```
 
 ### Account
 
 ```bash
 ship whoami
+ship account get
 ship config
 ship ping
 ```
 
 ```typescript
 ship.account.get()            // → whoami
-ship.ping()                   // → boolean
+ship.ping()                   // → { timestamp } (server clock; reachability is the absence of a throw)
 ship.getLimits()              // → platform plan limits (cached)
 ```
 
@@ -134,6 +139,8 @@ ship.getLimits()              // → platform plan limits (cached)
 
 The `-q` flag outputs only the resource identifier — perfect for piping and scripting:
 
+`ship tokens create -q` is the one exception: it prints the token **secret**, which is shown once and never again.
+
 ```bash
 # Deploy and link domain in one pipe
 ship ./dist -q | ship domains set www.example.com
@@ -141,8 +148,8 @@ ship ./dist -q | ship domains set www.example.com
 # Deploy and open in browser
 open https://$(ship ./dist -q)
 
-# Batch remove all deployments
-ship deployments list -q | xargs -I{} ship deployments remove {} -q
+# Batch delete all deployments
+ship deployments list -q | xargs -I{} ship deployments delete {} -q
 ```
 
 ### Shell Completion
@@ -164,8 +171,8 @@ Available on every command:
 | `--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 |
+| `-h, --help` | Display help for command |
+| `-V, --version` | Show version information |
 
 ### Deploy Flags
 
@@ -219,13 +226,9 @@ ship.setToken('ship-...');
 ship.deploy(input, {
   labels?: string[],
   password?: string,          // Password-protect the deployment (6–128 chars)
-  onProgress?: ({ percent }) => void,
-  signal?: AbortSignal,
-  onCancel?: () => void,      // Called if signal aborts
+  signal?: AbortSignal,       // Abort to cancel the deploy
   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
 });
 ```
@@ -273,6 +276,8 @@ ship.off('request', handler);
 
 Pass `fetch` to override the transport function used for every API call. Defaults to `globalThis.fetch`. Useful for wrapping requests with tracing, retries, or request signing, and for injecting a Cloudflare service-binding `Fetcher` from a Worker so calls reach a sibling Worker in-process instead of through the public hostname.
 
+This is also the seam for corporate proxies: Node's built-in `fetch` ignores `HTTP(S)_PROXY` environment variables, so behind a proxy inject a proxy-aware transport (e.g. [undici](https://github.com/nodejs/undici)'s `EnvHttpProxyAgent` as the dispatcher, or Node 24+'s `NODE_USE_ENV_PROXY=1`).
+
 ```typescript
 import type { Fetch } from '@shipstatic/ship';
 
@@ -315,7 +320,15 @@ The **CLI** (`ship`) resolves its token in this order:
 
 1. CLI flag: `--token`
 2. Environment variable: `SHIP_TOKEN`
-3. Config files: `.shiprc` or `package.json` `"ship"` key (run `ship config` to create one)
+3. Config file: `~/.shiprc` (run `ship config` to create one)
+
+`--config <file>` reads any path you name instead of `~/.shiprc`, which is how per-environment
+configs work (`ship --config dev.shiprc ...`). The file is strict JSON; an empty one means "no
+config".
+
+**No repository file is ever read.** A `.shiprc` or `package.json` `"ship"` key in your working
+directory is ignored — cloning a repo can never change which account you deploy to, or which
+host your token is sent to.
 
 The **SDK** (`new Ship(...)`) resolves its token in this order:
 

package/SKILL.md

@@ -223,9 +223,11 @@ Every command supports three modes:
 | `--json` | JSON on stdout | Parsing programmatically |
 | `-q` | Identifier only | Piping between commands |
 
+`-q` prints the resource identifier — except `tokens create -q`, which prints the token **secret** (shown once, never again).
+
 Errors go to stderr in all modes. Exit 0 = success, 1 = error.
 
-List commands return `{"<resource>s": [...], "cursor": null, "total": N}`. `domains list` text mode omits status — use `--json` to see `pending` vs `success`.
+List commands return `{"<resource>s": [...], "cursor": null}`. A non-null `cursor` means more pages remain — pass it back with `--cursor` to continue, and size pages with `--limit`. There is no total; a count is an aggregate over a collection, not a property of one page. `domains list` text mode omits status — use `--json` to see `pending` vs `success`.
 
 ## Commands
 
@@ -237,7 +239,7 @@ ship deployments upload <path>       # Deploy (explicit)
 ship deployments list                # List all
 ship deployments get <deployment>    # Details
 ship deployments set <deployment>    # Update labels (--label)
-ship deployments remove <deployment> # Delete (async)
+ship deployments delete <deployment> # Delete (async)
 ```
 
 ### Domains
@@ -251,7 +253,7 @@ ship domains records <name>           # Required DNS records
 ship domains dns <name>               # DNS provider lookup
 ship domains share <name>             # Shareable setup link
 ship domains verify <name>            # Trigger DNS verification
-ship domains remove <name>            # Delete
+ship domains delete <name>            # Delete
 ```
 
 ### Account & Tokens
@@ -262,7 +264,8 @@ 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 <token>            # Revoke
+ship tokens get <token>               # Details for one token
+ship tokens delete <token>            # Delete (revokes immediately)
 ```
 
 ## Flags