Client Installation

The haloy CLI tool runs on your local machine and triggers deployments to your servers.

Installation

Shell Script

To install the latest version via the official shell script:

curl -fsSL https://sh.haloy.dev/install-haloy.sh | sh
curl -fsSL https://sh.haloy.dev/install-haloy.sh | sh

Homebrew

If you are using macOS or Linux with Homebrew:

brew install haloydev/tap/haloy
brew install haloydev/tap/haloy

JavaScript Package Managers

npm install -g haloy
npm install -g haloy

pnpm add -g haloy
pnpm add -g haloy

bun add -g haloy
bun add -g haloy

Project Dev Dependency

For project-specific installations, add haloy as a dev dependency:

npm install --save-dev haloy
npm install --save-dev haloy

pnpm add -D haloy
pnpm add -D haloy

bun add -D haloy
bun add -D haloy

Then use it via npm scripts in your package.json:

// ...
{
  "scripts": {
    "deploy": "haloy deploy",
    "deploy:staging": "haloy deploy --target staging",
    "deploy:prod": "haloy deploy --target production",
    "status": "haloy status"
  }
}
// ...
{
  "scripts": {
    "deploy": "haloy deploy",
    "deploy:staging": "haloy deploy --target staging",
    "deploy:prod": "haloy deploy --target production",
    "status": "haloy status"
  }
}

Verify Installation

Check that haloy is installed correctly:

haloy version
haloy version

Uninstalling

See the Uninstalling guide for instructions on removing Haloy from your system.