Skip to content

Quick start

Deploy a project from your terminal. You need a Hiraiship account and a Vite, Rasengan.js, Hono or Futon project on your machine; a folder of static files works too.

  1. Install the CLI

    Terminal
    npm install -g @hiraiship/cli

    It needs Node.js 20.12 or later. See CLI overview for other ways to run it.

  2. Log in

    Terminal
    hiraiship login

    The CLI prints a one-time code and opens the dashboard in your browser. Check that the code matches, approve it, and the CLI is logged in. See Authentication.

  3. Deploy

    From your project's directory:

    Terminal
    hiraiship deploy

    The first time, the CLI asks which project to deploy to and offers to create one. The project's slug becomes its address: my-app is served at my-app.hiraiship.app. The link is saved in .hiraiship/project.json, so later deploys go to the same project without asking.

    The CLI then uploads your files, follows the build step by step, and prints the URL once it's live:

    Output
    ✔ Deployed → https://my-app.hiraiship.app

What just happened

  1. The CLI packed your directory, leaving out node_modules, .git, .env files and whatever your .gitignore lists. See Ignoring files.
  2. Hiraiship detected the framework, installed your dependencies with the package manager your lockfile names, and ran the build. See Builds.
  3. The output was published to Cloudflare's network, behind your project's domain.

Next steps