Global options
These options work with every command. Each has an environment variable, handy in CI; the option wins when both are set.
| Option | Environment variable | Description |
|---|---|---|
--scope <workspace> | HIRAISHIP_SCOPE | The workspace to act in, by its slug. Without it, your default workspace. |
--token <token> | HIRAISHIP_TOKEN | A login token or API key to use instead of the stored login. See Authentication. |
--api-url <url> | HIRAISHIP_API_URL | The Hiraiship API to talk to. Only needed for a staging or self-hosted API. |
--version | Print the CLI's version. | |
--help | Print a command's usage. |
hiraiship deploy also reads HIRAISHIP_MACHINE, the build machine for the deployment.
Workspaces and --scope
Without --scope, commands act in your default workspace, the first one hiraiship whoami lists. To deploy to a project in another workspace:
A linked directory remembers its workspace in .hiraiship/project.json, so deploy doesn't need --scope again. An API key always acts in its own workspace.