Package Exports
- @hololabdev/hhl-cli
- @hololabdev/hhl-cli/dist/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@hololabdev/hhl-cli) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
@hololabdev/hhl-cli
CLI for orchestrating local development across a multi-app workspace.
Install
npm install -g @hololabdev/hhl-cliFrom a git checkout:
pnpm install
pnpm build
node bin/hhl.js install # optional: register `hhl` in your shellShell completion (optional):
eval "$(hhl completion bash)" # or: hhl completion zshQuick start
hhl setup
hhl doctor
hhl devCommands
Getting started
| Command | Description |
|---|---|
hhl setup |
Install dependencies, copy env templates, optional MongoDB |
hhl doctor |
Workspace health checks (--fix to auto-repair) |
hhl install |
Register the hhl shell command |
Development
| Command | Description |
|---|---|
hhl dev |
Start services (--profile, --only, --show, --grep) |
hhl run <service> [script] |
Run npm script (--list to show scripts) |
hhl build |
Build all services in profile (--only) |
hhl stop [service] |
Stop all services or one by id |
hhl restart [service] |
Restart one or all (--all) |
hhl status |
PID table with uptime (--watch) |
hhl logs [service] |
Tail logs (--follow, --all, --since 5m) |
hhl open [service] |
Open service URL in the browser (--all) |
Environment
| Command | Description |
|---|---|
hhl env check [service] |
List missing required env keys |
hhl env diff [service] |
Compare .env keys with example file |
hhl env init <service> |
Interactive setup (--force to re-prompt) |
hhl env set <service> <KEY> <value> |
Set a single env value |
hhl ssl [service] |
Generate self-signed SSL certs (--all) |
hhl config |
Print current configuration |
hhl config set workspace <path> |
Set workspace root |
hhl kill-port <port> |
Free a port blocked by another process |
CLI
| Command | Description |
|---|---|
hhl version |
Show version, Node.js, install source |
hhl upgrade |
Update the CLI |
hhl completion bash|zsh |
Print shell completion script |
hhl -v |
Print version (shortcut) |
Profiles
Profiles are defined in hhl.config.json:
| Profile | Typical use |
|---|---|
full |
All apps in the workspace |
device |
Apps needed for on-device testing |
backend |
API / server apps only |
Examples:
hhl dev
hhl dev --profile backend
hhl dev --show be,fe
hhl dev --grep "error|warn"
hhl run be --list
hhl run be db:migrate
hhl build --profile backend
hhl restart --all
hhl logs be --since 5mConfiguration
- Copy
hhl.config.example.json→hhl.config.json. - Set
workspaceRootto the directory that contains your app folders. - Adjust
apps,profiles, and optionalrequiredEnvper service.
Runtime state and logs live under .hhl/ in the workspace root. Log files use ISO timestamps.
Set HHL_NO_UPDATE_NOTIFIER=1 to disable npm update hints.
Upgrade
hhl upgradeOr reinstall from npm:
npm install -g @hololabdev/hhl-cli@latest