CLI Reference
Complete hpsetup command-line arguments and options.
Usage
pnpm dlx hpsetup@latest <key> [product] [options]
HEROUI_KEY=<key> pnpm dlx hpsetup@latest [product] [options]bunx hpsetup@latest <key> [product] [options]
HEROUI_KEY=<key> bunx hpsetup@latest [product] [options]npx -y hpsetup@latest <key> [product] [options]
HEROUI_KEY=<key> npx -y hpsetup@latest [product] [options]Arguments
| Argument | Description |
|---|---|
<key> | API key, usually in the hp_xxxx format. |
[product] | Optional product name. Use the default when omitted. |
Environment variables
| Variable | Description |
|---|---|
HEROUI_KEY | API key used when the key is not passed as a positional argument. |
CI | Enables non-interactive CI behavior when present. |
Common options
| Option | Description |
|---|---|
--update | Update existing generated files. |
--auto | Run without interactive prompts. |
--cwd <path> | Run installation from a specific project directory. |
Examples
Install locally:
pnpm dlx hpsetup@latest hp_xxxxInstall in CI:
HEROUI_KEY=hp_xxxx npx -y hpsetup@latestInstall from a workspace root:
pnpm dlx hpsetup@latest hp_xxxx --cwd apps/web