HeliumTS is under active development and may have bugs or breaking changes. Report issues on GitHub.

CLI Reference

These commands target the 0.11.0 release. Use matching 0.11.0 framework and scaffolder versions.

%helium typegen
%helium inspect --rpc getTasks --json
%helium inspect --route '/tasks/:id' --json
%helium api useCall --from client --json
%helium api --list --match define --from server
%helium check

Typegen refreshes src/rpc.generated.ts without starting a server. Inspect reports routes, rendering modes, methods and middleware as JSON. Check regenerates declarations, validates discovery and runs TypeScript. It does not replace application tests or a production build.

Start with inspect for an application method or route and api for the exact framework declaration. Source discovery does not execute application modules. Read one focused task guide rather than loading the whole reference for every edit.

%helium dev

Starts the project in development mode.

%helium build

i. Builds the client.
ii. Scans src/server for exports.
iii. Bundles the server using esbuild.
iv. Transpiles helium.config.ts to dist/helium.config.js (if present).

%helium start

Runs the bundled server (dist/server.js).