Skip to content
docs

Create a project

Creating a project also creates its production environment and its <slug>.hiraiship.app domain.

From the CLI

Run hiraiship deploy, or hiraiship link to create the project without deploying, in a directory that isn't linked yet:

Terminal
hiraiship link
Output
◆ Link this directory to which project?
│ ● Create a new project
│ ○ api (api)
◆ Project name
│ my-app
◆ Project slug (becomes its subdomain)
│ my-app
✔ Linked to my-app (my-app) in My workspace
  • The name defaults to package.json's name without its npm scope, or to the directory's name.
  • The slug is checked as you type: it must be free across Hiraiship, since it becomes a hostname.
  • If you're a member of several workspaces, the CLI first asks which one; or pass --scope <workspace>.

The link is saved in .hiraiship/project.json, and .hiraiship is added to your .gitignore. See link.

Choosing a slug

A project's slug can't be changed once it's created, and it's public: my-app.hiraiship.app. Pick something you're happy to show, or plan to serve the app from a custom domain.

A slug is one part of a hostname:

  • lowercase letters, digits and hyphens, 63 characters at most;
  • no hyphen at the start or the end;
  • not a name Hiraiship keeps for itself, such as www, api, app, admin, docs or status;
  • not used by another project, and not by a project another workspace deleted less than 30 days ago. Your own workspace can reuse the slug of a project it deleted at once.

Limits

Projects are unlimited, but each plan creates a limited number per hour; see Projects.