overview getting started

Getting started

Use Node.js, npm, Rust/Cargo, and the Tauri system dependencies for your platform. The commands below mirror the scripts and CI workflow in package.json and .github/workflows/ci.yml.

Install

npm install
npm run install:k6

npm run install:k6 runs scripts/install-k6.sh, which downloads the project-local k6 binary into src-tauri/bin/ with checksum checks for the default version.

Run the app

npm run tauri dev

Tauri uses the dev pre-command in src-tauri/tauri.conf.json: npm run install:k6 && npm run dev. Vite serves the frontend at http://localhost:5173, and the desktop shell opens the main window defined in src-tauri/tauri.conf.json.

Validate changes

npm run lint
npm run typecheck
npm test
cd src-tauri && cargo test
cd src-tauri && cargo check

CI also runs npm run build after frontend tests, as defined in .github/workflows/ci.yml.

Build

npm run build
npm run tauri build

npm run build runs TypeScript and Vite, then writes static assets to dist/. npm run tauri build runs the Tauri build pre-command from src-tauri/tauri.conf.json, then writes native bundles under src-tauri/target/release/bundle/.

Common environment variables

Variable	Used by	Purpose
K6_VERSION	scripts/install-k6.sh	Overrides the bundled k6 version
K6_SHA256	scripts/install-k6.sh	Required checksum when K6_VERSION is overridden
LOADRIFT_K6_BIN	src-tauri/src/k6/process/runtime.rs	Points runtime resolution at a specific k6 executable
LOADRIFT_PRESERVE_K6_ARTIFACTS	src-tauri/src/k6/process/runtime.rs	Keeps generated k6 temp artifacts for debugging
LOADRIFT_REQUIRE_BUNDLED_K6_TESTS	Rust tests	Makes bundled-k6 regression tests mandatory

See Configuration for the full configuration reference.