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

Build with HeliumTS

HeliumTS connects React pages to TypeScript server methods in one Vite project. File routes, generated RPC references and built-in hooks give people and coding agents the same explicit application structure.

The everyday workflow

  1. Define a server method with defineMethod. Validate unknown inputs and enforce authorization on the server.
  2. Import its reference from src/rpc.generated.ts in the browser. Import hooks and routing from heliumts/client.
  3. Read with useFetch, mutate with useCall, and invalidate every affected read. Render loading and error states; expose refresh when users need it.
  4. Add a file under src/pages for the URL. Choose client rendering, SSR or SSG per page.

Normal application RPC needs no handwritten HTTP endpoint, fetch wrapper or separate TanStack Query setup. HTTP handlers remain available for webhooks, downloads and integrations that need an explicit HTTP contract. RPC uses HTTP; streaming uses length-prefixed MessagePack frames.

Start small

The 0.11.0 release starts with one page, one RPC method and plain CSS. Use matching 0.11.0 framework and scaffolder versions.

%npm create heliumts-app@latest my-app
%cd my-app
%npx helium typegen
%npx helium check
%npm run dev
Installation and version compatibility

Give your agent a precise starting point

Read the project’s AGENTS.md, then one relevant task guide. Use helium inspect to locate app code and helium api for a framework signature. Run type checks and the behavior tests after edits. Type safety does not replace validation, permissions or cancellation.

Use the rendering mode your page needs

Interactive pages render in the browser by default. Add "use ssr" for request-time HTML or "use ssg" for build-time HTML. Use server-side or static props for initial data; browser RPC hooks do not fetch during server rendering.