安装

要求 Node.js 版本 >= 20。

npm install -g @shipstatic/ship

身份验证

ship config

提示时输入您的 API 密钥。您可在 https://my.shipstatic.com/settings 获取一个密钥。

替代方式：设置 SHIP_API_KEY 环境变量，或在每个命令中通过 --api-key 参数传入。

工作流 1 — 部署

ship ./dist
ship ./dist --label production --label v1.0
ship ./dist --json   # 返回 {"deployment": "", "url": "https://..."}

工作流 2 — 预留域名

# 预检检查
ship domains validate www.example.com

# 预留域名（暂不关联任何部署）
ship domains set www.example.com

# 或预留一个内部子域名（即时生效，无需 DNS 配置）
ship domains set my-site

内部域名（如 my-site.shipstatic.com）免费且即时生效。自定义域名需配置 DNS — CLI 会输出所需的 DNS 记录。

不支持根域名（Apex domains）。请始终使用子域名：例如 www.example.com，而非 example.com。

工作流 3 — 将域名绑定至部署

# 将域名绑定至指定部署
ship domains set www.example.com 

# 切换至另一部署（即时回滚）
ship domains set www.example.com 

# 对于自定义域名：在完成 DNS 记录配置后，执行验证
ship domains verify www.example.com

参考命令

# 部署相关
ship deployments list
ship deployments get 
ship deployments set  --label production
ship deployments remove 

# 域名相关
ship domains list
ship domains get 
ship domains validate 
ship domains verify 
ship domains remove 

# 账户相关
ship whoami
ship ping

对任意命令添加 --json 参数，可获得机器可读的 JSON 输出。