Installation

@fullhaus/rivet is published to the private FULLHAUS registry.

Requirements

• Node ≥ 24 or Bun ≥ 1.3
• A valid token for npm.fullhaus.dev (FH_PRIVATE_NPM_TOKEN)

Configure the registry

Add an .npmrc to your project so the @fullhaus scope points at the private registry:

.npmrc

@fullhaus:registry=https://npm.fullhaus.dev/
//npm.fullhaus.dev/:_authToken=${FH_PRIVATE_NPM_TOKEN}

Set the token as an environment variable (e.g. in your shell or CI):

export FH_PRIVATE_NPM_TOKEN="your-token"

Caution

Never commit the real token. The .npmrc only references the environment variable ${FH_PRIVATE_NPM_TOKEN} — the token itself stays outside the repo.

Install the package

# Bun
bun add @fullhaus/rivet

# pnpm
pnpm add @fullhaus/rivet

# npm
npm install @fullhaus/rivet

Import paths

Rivet exposes two entry points:

Import	Contents
@fullhaus/rivet	Component runtime: createRivet, defineComponent, signals
@fullhaus/rivet/logger	Standalone logger (independent of the runtime)

import { createRivet, defineComponent, signal } from "@fullhaus/rivet";
import { createLogger, logger } from "@fullhaus/rivet/logger";

The package is pure ESM ("type": "module"), ships type declarations, and is sideEffects: false — tree-shaking works out of the box.

Next step

Continue to the Quick Start to mount your first component.