shipstatic-cli 1.3.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 shipstatic
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,75 @@
+# shipstatic-cli
+
+> ⚡ **The package you're looking for is [`@shipstatic/ship`](https://www.npmjs.com/package/@shipstatic/ship)** — that's where the code and the full documentation live.
+>
+> This is an alias for it, so a guess at the unscoped name doesn't dead-end. **Use it directly** — `npx shipstatic-cli` runs the same binary, `import Ship from 'shipstatic-cli'` resolves to the same module. Nothing to switch to.
+
+Deploy a static site from the terminal or from code.
+
+## Deploy
+
+```bash
+npx shipstatic-cli ./dist
+```
+
+**No account, no API key, no config, no install.** This works in a fresh sandbox with no secrets set.
+
+Point it at your **built output** — `./dist`, `./build`, `./out` — not your project root. Build first if the project needs it. A single file works too:
+
+```bash
+npx shipstatic-cli ./index.html
+```
+
+**What you get back:** the live URL, plus a **claim URL**.
+
+> Anonymous deployments are **public** and **expire in 3 days**. The claim URL is how one becomes permanent — surface it to whoever asked for the deploy.
+
+## Auth — deploy needs none, everything else does
+
+| | |
+|---|---|
+| **Deploying** — `npx shipstatic-cli ./dist`, and `npx shipstatic-cli deployments upload ./dist` | **Nothing.** No account, no API key, no deploy token, no login. |
+| **Everything else** — domains, tokens, `whoami`, listing deployments | **Requires an API key.** |
+
+> **`ship whoami` failing is normal** without a key, and it says nothing about deploying. An authentication error from any other command is not a reason the deploy won't work — run the deploy anyway. It stays anonymous.
+
+Need the rest? Get a free key at [my.shipstatic.com/api-key](https://my.shipstatic.com/api-key), then `ship config`.
+
+## Common tasks
+
+| Goal | Command |
+|---|---|
+| Deploy a folder | `npx shipstatic-cli ./dist` |
+| Deploy one file | `npx shipstatic-cli ./index.html` |
+| Password-protect it | `npx shipstatic-cli ./dist --password "secret"` |
+| Machine-readable output | `npx shipstatic-cli ./dist --json` |
+| Keep the password out of logs | `SHIP_PASSWORD="secret" npx shipstatic-cli ./dist` |
+| Repeat use | `npm install -g shipstatic-cli` → the `ship` command |
+
+## For scripts and agents
+
+```bash
+npx shipstatic-cli ./dist --json
+```
+
+- **`--json`** emits machine-readable output on success **and** on failure.
+- **Exit code** is `0` on success, non-zero on failure. Branch on it, not on the text.
+- **Errors** carry a stable `error` type and `status`. Branch on those, never on the message string.
+- **`--no-color`** is honoured; colour is off automatically when stdout is not a TTY.
+- **`SHIP_PASSWORD`** supplies `--password` from the environment.
+
+Deploying needs no credentials, so there is nothing to configure before the first run and nothing to leak in a log.
+
+## From code
+
+```javascript
+import Ship from 'shipstatic-cli';
+
+const result = await new Ship().deploy('./dist');
+// result.deployment → live URL
+// result.claim      → visit to keep permanently
+```
+
+## Full documentation
+
+Custom domains, API keys, deploy tokens, managing deployments, the complete SDK reference — **[`@shipstatic/ship`](https://www.npmjs.com/package/@shipstatic/ship)**.

package/bin.cjs

@@ -0,0 +1,14 @@
+#!/usr/bin/env node
+// The `ship` binary, forwarded.
+//
+// Loaded IN-PROCESS, never spawned. `@shipstatic/ship`'s command tree
+// deliberately avoids `process.exit` so buffered stdout survives a pipe; a
+// spawning trampoline would reintroduce exactly the truncation class that
+// design exists to prevent, and would have to re-plumb exit codes and signals
+// besides. Requiring it means this process IS the CLI.
+//
+// `@shipstatic/ship/cli` is a declared subpath (added in ship 1.1.0). Before
+// that it did not exist, and reaching `dist/cli.cjs` meant path-joining off
+// the resolved main entry — past the exports map whose whole job is to say
+// what is reachable. Do not reintroduce that; raise the dependency instead.
+require('@shipstatic/ship/cli');

package/index.cjs

@@ -0,0 +1,9 @@
+// The CJS forward.
+//
+// Assigning the required namespace wholesale — rather than re-exporting names
+// one by one — is what keeps this file from being a list that drifts. Ship's
+// own CJS entry is itself an assignment (`module.exports = Ship` plus every
+// named export and a `default`, applied by its post-build step), so forwarding
+// the object preserves the callable-constructor shape, the named exports and
+// `.default` in one line, and gains any export ship adds for free.
+module.exports = require('@shipstatic/ship');

package/index.d.cts

@@ -0,0 +1,9 @@
+// Types for the CJS forward.
+//
+// A separate file per module format, rather than one shared `.d.ts`, because
+// TypeScript resolves declarations through the SAME conditions as the runtime:
+// under `node16` a `require` of this package must land on CJS types and an
+// `import` on ESM types. One shared file makes `attw` report a format mismatch
+// on whichever half it does not match.
+export * from '@shipstatic/ship';
+export { default } from '@shipstatic/ship';

package/index.d.mts

@@ -0,0 +1,3 @@
+// Types for the ESM forward. See index.d.cts for why the two are separate.
+export * from '@shipstatic/ship';
+export { default } from '@shipstatic/ship';

package/index.mjs

@@ -0,0 +1,14 @@
+// The ESM forward, and the browser one.
+//
+// `export *` does NOT carry a default export — that is a language rule, not an
+// oversight — so the second line is load-bearing: without it
+// `import Ship from 'shipstatic'` resolves to undefined while every named
+// import keeps working, which is the kind of break that reaches users rather
+// than CI.
+//
+// This file is also the `browser` condition's target. The specifier below is
+// bare, so a bundler re-resolves `@shipstatic/ship` under its OWN conditions
+// and lands on ship's browser build — the forward stays correct per-platform
+// without this package naming a platform anywhere.
+export * from '@shipstatic/ship';
+export { default } from '@shipstatic/ship';

package/package.json

@@ -0,0 +1,77 @@
+{
+  "name": "shipstatic-cli",
+  "version": "1.3.0",
+  "description": "CLI and SDK for ShipStatic — deploy static websites, landing pages, and prototypes instantly. The unscoped name for @shipstatic/ship.",
+  "keywords": [
+    "shipstatic",
+    "static-hosting",
+    "deploy",
+    "cli",
+    "sdk"
+  ],
+  "homepage": "https://shipstatic.com",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/shipstatic/shipstatic-cli.git"
+  },
+  "license": "MIT",
+  "type": "module",
+  "bin": {
+    "ship": "./bin.cjs"
+  },
+  "main": "./index.cjs",
+  "module": "./index.mjs",
+  "types": "./index.d.cts",
+  "exports": {
+    ".": {
+      "browser": {
+        "types": "./index.d.mts",
+        "default": "./index.mjs"
+      },
+      "import": {
+        "types": "./index.d.mts",
+        "default": "./index.mjs"
+      },
+      "require": {
+        "types": "./index.d.cts",
+        "default": "./index.cjs"
+      }
+    },
+    "./cli": "./bin.cjs",
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "bin.cjs",
+    "index.cjs",
+    "index.mjs",
+    "index.d.cts",
+    "index.d.mts",
+    "README.md"
+  ],
+  "sideEffects": false,
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "packageManager": "pnpm@10.12.4",
+  "scripts": {
+    "test": "vitest",
+    "test:ci": "vitest --run",
+    "check:package": "publint && attw --pack . --ignore-rules false-export-default --exclude-entrypoints cli",
+    "prepare": "git config core.hooksPath scripts/githooks",
+    "lint": "biome check .",
+    "format": "biome format --write ."
+  },
+  "dependencies": {
+    "@shipstatic/ship": "^1.3.0"
+  },
+  "devDependencies": {
+    "@arethetypeswrong/cli": "^0.18.5",
+    "@biomejs/biome": "2.5.5",
+    "publint": "^0.3.12",
+    "vitest": "^4.1.10"
+  },
+  "bugs": {
+    "url": "https://github.com/shipstatic/ship/issues"
+  },
+  "author": "ShipStatic"
+}