Skip to content

Install

The CLI is not published to npm yet, so today it is built from source. Node 22 or newer, and a browser only if you want to verify.

What the machine needs

Why Checked by
Node 22 or newer The floor is the oldest Node still receiving security patches hiiu doctor
git Builds mirror a committed revision, and fork initialises a workspace hiiu doctor
A package manager The base installs with the app's own, from the app's own lockfile hiiu doctor
Playwright Only hiiu verify needs a browser hiiu doctor, as a warning

Playwright is a warning and never a failure. A machine that only ever reads a repository is healthy without a browser, and paying for a per-platform browser download before you can run hiiu analyze would be the wrong trade.

From source

git clone https://gitlab.com/hiiu-group/hiiu.git
cd hiiu
bun install
bun run build

That writes a single file, packages/cli/dist/hiiu.js, which runs on Node:

node packages/cli/dist/hiiu.js doctor

Put it on your path if you are going to use it more than once:

alias hiiu="node $PWD/packages/cli/dist/hiiu.js"
hiiu doctor

Every example in these docs is written as hiiu, on the assumption you have done something like that.

When it ships

The published package will be @hiiu/cli and the binary it installs is hiiu, so onboarding will be one line and will need no clone:

npx @hiiu/cli init

Until then, treat the source build as the only route, and hiiu doctor as the thing that tells you whether it worked.

Check it worked

hiiu doctor

A healthy machine exits 0. A missing browser is a warn and still exits 0. Anything that would stop a build is a fail and exits 3, naming the check.

Next: the quickstart, which runs the pipeline on a repo of your own.