Skip to content

CLI

The hiraiship command deploys a directory from your terminal or from CI: it packs your files, uploads them, and follows the build until the deployment is live.

Install

The CLI needs Node.js 20.12 or later.

Terminal
npm install -g @hiraiship/cli

Or run it without installing:

Terminal
npx @hiraiship/cli deploy

Check it works:

Terminal
hiraiship --version

Commands

CommandWhat it does
hiraiship loginLog in through the dashboard
hiraiship logoutLog out and revoke the session
hiraiship whoamiShow your account and workspaces
hiraiship linkLink a directory to a project
hiraiship deployDeploy a directory

hiraiship help <command> lists a command's options. Every command also takes the global options.

A typical session

Terminal
hiraiship login
cd my-app
hiraiship deploy

Exit codes

CodeMeaning
0Success
1Failure: a failed build, a failed publish, a refused request
130Interrupted with Ctrl-C, or a prompt canceled

hiraiship deploy exits with 1 when the build or its publication fails, so a CI job fails with it.