@shadw/node
v0.1.0
Published
Boot a real shadw platform node locally, as easily as any other npx dev tool
Readme
@shadw/node
Boot a real shadw platform node locally — as easily as
any other npx dev tool. This runs the actual hive-cloud server binary (the
same one every fleet node runs), not a simulation of one.
npx @shadw/nodeThat's it (npm resolves a scoped package's sole bin entry regardless of
name, so this runs the shadw-node command — the same mechanism
@angular/cli/@vue/cli use). It boots a single local node with sane dev
defaults:
HIVE_FORCE_MOCK=1 HIVE_DATA=~/.shadw-node hive-cloud \
--name local --listen 127.0.0.1:8787 --admin 127.0.0.1:8786Then:
curl http://127.0.0.1:8786/healthz
npx @shadw/cli --api http://127.0.0.1:8786 auth login # point the CLI at itPass any argument yourself and you get full control, zero injected defaults —
shadw-node becomes a thin exec wrapper around hive-cloud at that point:
npx @shadw/node --name mynode --listen 0.0.0.0:8787 --admin 127.0.0.1:8786Why HIVE_FORCE_MOCK=1 by default
This tool is for local dev and demos, not production fleet nodes.
Production nodes are provisioned through this repo's own ansible roles, which
do real hardware/KVM detection, mesh bootstrap, TLS certificates, and more.
shadw-node mirrors scripts/dev-cluster.sh's single-node shape instead:
functions run as real host processes (the same isolation tier the platform's
own mock-backend fleet nodes use), with no assumption that your machine has
KVM or Firecracker available. Set HIVE_FORCE_MOCK=0 yourself if you know
what you're doing and want the real backend-selection logic to run.
Platforms
| Platform | Package | Status |
|---|---|---|
| macOS (Apple Silicon) | @shadw/node-darwin-arm64 | ✅ built + locally verified (real node booted, healthz answered) |
| macOS (Intel) | @shadw/node-darwin-x64 | ✅ built |
| Linux (x64) | @shadw/node-linux-x64 | 🚧 built by CI (.github/workflows/release-npm-cli.yml) on the next cli-v* tag |
| Linux (arm64) | @shadw/node-linux-arm64 | 🚧 built by CI on the next cli-v* tag |
This is a real platform server binary (~75-80 MiB, stripped) — large compared
to a typical npx tool, and that's inherent to shipping a real distributed
systems node rather than a bug to fix.
Source
Wraps hive-cloud
in this monorepo. scripts/build-npm-pkg.sh is the single source of truth for
how every platform package here is built and staged.
