Skip to content
This repository was archived by the owner on Oct 28, 2026. It is now read-only.

Development

speedyrulz edited this page Oct 28, 2026 · 1 revision

Development

npm install
node node_modules/electron/install.js   # first time only: Electron downloads its binary lazily
npm run dev          # run with hot reload
npm test             # unit tests
npm run test:e2e     # builds, then drives the app with Playwright against a mock RulZ server
npm run typecheck
npm run build:win    # installer → dist/RulZ-Coding-Agent-Setup-<version>.exe

Real-model check

This needs RulZ LLM Suite serving a model. It builds a to-do app, adds dark mode, undoes it, and writes test-results/real-model.md:

$env:RULZ_REAL = '1'; npx vitest run --config vitest.e2e.config.ts real-model

Add $env:RULZ_REAL_REA = '1' to also run the REA check, which needs REA set up in RulZ LLM Suite.

Layout

Folder What's there
src/main Electron main process: agent loop (agent/), RulZ client (rulz/), projects and Undo (project/), tool servers (mcp/), phone access (remote/), settings
src/renderer React UI: pages, components (including ModelSettings.tsx), stores
src/shared Types, defaults and IPC channels shared by both
tests Unit tests, e2e tests and the mock RulZ server (tests/helpers/mockRulz.ts)

Releases

Pushing a version tag such as v0.7.0 builds the installer on GitHub Actions and attaches it to a GitHub Release.

Clone this wiki locally