@hla4ts/create-spacekit
v0.1.1
Published
Scaffold a minimal @hla4ts/spacekit rover app
Downloads
214
Readme
@hla4ts/create-spacekit
Scaffold a minimal @hla4ts/spacekit lunar rover app.
The generated project is intentionally simpler than the repo's validation
examples. It creates one PhysicalEntity, drives it with SpacekitApp.run(),
and keeps the common RTI/Spacekit knobs in .env.
What It Generates
- a Bun + TypeScript project
- a single-file rover runtime built on
@hla4ts/spacekit .envdefaults for RTI host/port/TLS, federation, federate, frame, timing, and rover motion
Local Workspace Usage
From this repo checkout:
bun run --filter @hla4ts/create-spacekit cli -- my-roverIntended Published Usage
The package is structured with a bin entry so it is ready for:
bunx @hla4ts/create-spacekit my-roverThat one-line path still depends on publishing the package to the npm registry.
Options
--template lunar-rover--list-templates--federation-name <name>--federate-name <name>--federate-type <type>--rti-host <host>--rti-port <port>--rti-use-tls--parent-reference-frame <frame>--rover-name <name>--rover-type <type>--rover-speed-mps <value>--lookahead-micros <value>--update-period-micros <value>--reference-frame-timeout-ms <value>--reference-frame-missing-mode <mode>--workspace-deps--yes
--workspace-deps is for local monorepo validation. It writes
"@hla4ts/spacekit": "workspace:*" into the generated project instead of the
published semver range.
--reference-frame-missing-mode controls what the generated rover does when
its parent reference frame has not been published yet. The template default is
continue.
Generated App
After scaffolding:
cd my-rover
bun install
bun run startEdit .env to point at your RTI and federation.
