@shipstatic/ship 2.8.0 → 2.8.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +1 -1
- package/README.md +25 -13
- package/SKILL.md +1 -1
- package/package.json +14 -14
package/LICENSE
CHANGED
package/README.md
CHANGED
|
@@ -31,7 +31,7 @@ npm install -g @shipstatic/ship # global CLI — drop the `npx @shipstatic/shi
|
|
|
31
31
|
>
|
|
32
32
|
> 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).
|
|
33
33
|
|
|
34
|
-
## All
|
|
34
|
+
## All commands — free API key
|
|
35
35
|
|
|
36
36
|
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).
|
|
37
37
|
|
|
@@ -135,7 +135,7 @@ ship.ping() // → { timestamp } (server clock; reachability i
|
|
|
135
135
|
ship.getLimits() // → platform plan limits (cached)
|
|
136
136
|
```
|
|
137
137
|
|
|
138
|
-
## CLI
|
|
138
|
+
## CLI reference
|
|
139
139
|
|
|
140
140
|
### Composability
|
|
141
141
|
|
|
@@ -183,14 +183,14 @@ ship ./dist --domain www.example.com
|
|
|
183
183
|
|
|
184
184
|
Both spellings are supported and neither replaces the other. The pipe composes interactively — any two commands, wherever `-q` gives you the value the next one wants. `--domain` is one process, one exit code, and one `--json`, which is what CI needs: a `run:` block is `bash -e` **without** `pipefail`, so a pipeline reports only the last command's status and a failed deploy is masked. It answers as the domain, exactly as `ship domains set` does — DNS records and setup link included on a new external domain — and it needs a token, which it checks before uploading anything.
|
|
185
185
|
|
|
186
|
-
### Shell
|
|
186
|
+
### Shell completion
|
|
187
187
|
|
|
188
188
|
```bash
|
|
189
189
|
ship completion install
|
|
190
190
|
ship completion uninstall
|
|
191
191
|
```
|
|
192
192
|
|
|
193
|
-
### Global
|
|
193
|
+
### Global flags
|
|
194
194
|
|
|
195
195
|
Available on every command:
|
|
196
196
|
|
|
@@ -205,7 +205,7 @@ Available on every command:
|
|
|
205
205
|
| `-h, --help` | Display help for command |
|
|
206
206
|
| `-V, --version` | Show version information |
|
|
207
207
|
|
|
208
|
-
### Deploy
|
|
208
|
+
### Deploy flags
|
|
209
209
|
|
|
210
210
|
Available on `ship <path>` and `ship deployments upload`:
|
|
211
211
|
|
|
@@ -218,7 +218,7 @@ Available on `ship <path>` and `ship deployments upload`:
|
|
|
218
218
|
| `--no-path-detect` | Disable automatic path optimization |
|
|
219
219
|
| `--no-spa-detect` | Disable automatic SPA detection |
|
|
220
220
|
|
|
221
|
-
### CLI
|
|
221
|
+
### CLI environment variables
|
|
222
222
|
|
|
223
223
|
| Var | Purpose |
|
|
224
224
|
|---|---|
|
|
@@ -226,7 +226,7 @@ Available on `ship <path>` and `ship deployments upload`:
|
|
|
226
226
|
| `SHIP_API_URL` | Default for `--api-url` |
|
|
227
227
|
| `SHIP_PASSWORD` | Default for `--password` (empty string normalized to absence) |
|
|
228
228
|
|
|
229
|
-
## SDK
|
|
229
|
+
## SDK reference
|
|
230
230
|
|
|
231
231
|
### Authentication
|
|
232
232
|
|
|
@@ -272,7 +272,7 @@ a deploy replays its stored result instead of creating a second one.
|
|
|
272
272
|
`timeout` is the ceiling on one ATTEMPT. For a hard overall deadline pass your
|
|
273
273
|
own `signal` (`AbortSignal.timeout(ms)`), which is never retried past.
|
|
274
274
|
|
|
275
|
-
### Deploy
|
|
275
|
+
### Deploy options
|
|
276
276
|
|
|
277
277
|
```typescript
|
|
278
278
|
ship.deploy(input, {
|
|
@@ -311,7 +311,7 @@ await ship.deploy('./dist', { password: 'your-passphrase' });
|
|
|
311
311
|
|
|
312
312
|
The CLI also reads `SHIP_PASSWORD` from the environment when `--password` is not given.
|
|
313
313
|
|
|
314
|
-
### Browser
|
|
314
|
+
### Browser usage
|
|
315
315
|
|
|
316
316
|
```javascript
|
|
317
317
|
import Ship from '@shipstatic/ship';
|
|
@@ -420,10 +420,22 @@ import type { ShipClientOptions, DeploymentOptions, ShipEvents } from '@shipstat
|
|
|
420
420
|
import type { Deployment, Domain, Account, StaticFile } from '@shipstatic/types';
|
|
421
421
|
```
|
|
422
422
|
|
|
423
|
-
## AI
|
|
423
|
+
## AI agents
|
|
424
424
|
|
|
425
|
-
This package includes a [SKILL.md](./SKILL.md) file
|
|
425
|
+
This package includes a [SKILL.md](./SKILL.md) file, a portable skill definition that AI agents (Claude Code, Codex, and any other skills-aware tool) use to deploy sites with `ship` autonomously.
|
|
426
426
|
|
|
427
|
-
|
|
427
|
+
## Also available
|
|
428
|
+
|
|
429
|
+
| Surface | Reach it |
|
|
430
|
+
|---------|----------|
|
|
431
|
+
| **[MCP](https://mcp.shipstatic.com)** | Drop `https://mcp.shipstatic.com` into any MCP client |
|
|
432
|
+
| **[VS Code](https://marketplace.visualstudio.com/items?itemName=shipstatic.shipstatic)** | Search "ShipStatic" in the Marketplace |
|
|
433
|
+
| **[Gemini CLI](https://github.com/shipstatic/plugin)** | `gemini extensions install https://github.com/shipstatic/plugin` |
|
|
434
|
+
| **[n8n](https://www.npmjs.com/package/n8n-nodes-shipstatic)** | Search "ShipStatic" in n8n's node panel |
|
|
435
|
+
| **[GitHub Action](https://github.com/shipstatic/action)** | `shipstatic/action@v2` |
|
|
436
|
+
| **[Agent Skill](https://www.shipstatic.com/SKILL.md)** | One file, for any skills-aware tool |
|
|
437
|
+
|
|
438
|
+
## License
|
|
439
|
+
|
|
440
|
+
MIT
|
|
428
441
|
|
|
429
|
-
Part of the [ShipStatic](https://shipstatic.com) platform.
|
package/SKILL.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: ship
|
|
3
|
-
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.
|
|
3
|
+
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. Free, no account needed. CLI (`ship`) and Node.js/browser SDK."
|
|
4
4
|
compatibility: "Node.js >= 20.19. Run via npx (no install) or install globally: npm install -g @shipstatic/ship"
|
|
5
5
|
metadata:
|
|
6
6
|
openclaw:
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@shipstatic/ship",
|
|
3
|
-
"version": "2.8.
|
|
4
|
-
"description": "
|
|
3
|
+
"version": "2.8.1",
|
|
4
|
+
"description": "CLI and SDK for ShipStatic. Deploy static websites, landing pages, and prototypes instantly from the terminal or code.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.cjs",
|
|
7
7
|
"module": "./dist/index.js",
|
|
@@ -52,23 +52,23 @@
|
|
|
52
52
|
"THIRD-PARTY-LICENSES.md"
|
|
53
53
|
],
|
|
54
54
|
"keywords": [
|
|
55
|
-
"
|
|
56
|
-
"cli",
|
|
57
|
-
"custom-domain",
|
|
55
|
+
"shipstatic",
|
|
58
56
|
"deploy",
|
|
59
|
-
"developer-tools",
|
|
60
57
|
"hosting",
|
|
61
|
-
"jamstack",
|
|
62
|
-
"sdk",
|
|
63
|
-
"ship",
|
|
64
|
-
"static-hosting",
|
|
65
58
|
"static-site",
|
|
66
|
-
"
|
|
67
|
-
"vibe-coding",
|
|
59
|
+
"static-hosting",
|
|
68
60
|
"web-hosting",
|
|
69
|
-
"website"
|
|
61
|
+
"website",
|
|
62
|
+
"cli",
|
|
63
|
+
"sdk",
|
|
64
|
+
"ai",
|
|
65
|
+
"agent",
|
|
66
|
+
"jamstack",
|
|
67
|
+
"custom-domain",
|
|
68
|
+
"typescript",
|
|
69
|
+
"vibe-coding"
|
|
70
70
|
],
|
|
71
|
-
"homepage": "https://
|
|
71
|
+
"homepage": "https://shipstatic.com",
|
|
72
72
|
"repository": {
|
|
73
73
|
"type": "git",
|
|
74
74
|
"url": "git+https://github.com/shipstatic/ship.git"
|