Skip to content

hiraiship link

Links a directory to a project, creating the project if you choose to, without deploying anything.

Terminal
hiraiship link [dir] [options]

hiraiship deploy links an unlinked directory on its own; link is for doing it ahead of time, or for changing the project a directory deploys to.

Options

OptionDescription
--project <slug>Link to this existing project, without prompting.

With --scope <workspace>, the project is looked up in that workspace. See global options.

Without --project

The CLI asks:

  1. which workspace, if you're a member of several;
  2. which project: one of the workspace's, or a new one. A new project asks for a name and a slug; see Create a project.

The link is saved in .hiraiship/project.json:

.hiraiship/project.json
{
  "projectId": "8c1f…",
  "environmentId": "2b7d…",
  "projectSlug": "my-app",
  "apiUrl": "https://api.hiraiship.com",
  "workspaceSlug": "my-team"
}

The CLI adds .hiraiship to your .gitignore: the link is local to your machine. In CI, pass --project instead of committing it.

Changing the linked project

Run link again with --project:

Terminal
hiraiship link --project other-app

Without it, link on a linked directory only says which project it's linked to.