Repository navigation
Coding Agent 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
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.
| 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) |
The app lives in apps/rulz-coding-agent of the suite repository. Pushing a tag named coding-agent-v<version> (for example coding-agent-v0.18.1) runs the suite's Apps workflow (.github/workflows/apps.yml): it type-checks, runs the unit tests, builds the installer and attaches it to a GitHub Release in the suite repository, which is where the launcher downloads it from. The tag's version must match version in package.json, or the release stops.
RulZ AI Tools Suite
The apps
RulzTrainer
Rulz Training Captioner
Getting started
Using the app
Models and GPUs
Reference
RulZ LLM Suite
Using the app
- Getting Started
- Building the Engine
- Model Library
- Loading Models
- Chat
- MCP Tools
- Reverse Engineering
- Local API Server
Reference
Contributing
RulZ Coding Agent
Using the app
- Getting Started
- Projects and Tasks
- Approvals and Safety
- Model Settings
- Run and Share
- Notes and Instructions
- Extra Tools (MCP)
- Phone Access
Reference
Contributing
RulZ Image Organizer
Using RulZ
- Getting Started
- Library and Scanning
- People and Corrections
- Search and Filters
- Photo Viewer
- Appearance
More
RulZ Image Tournament
Using the app
- Getting Started
- How the Tournament Works
- Comparing Images
- Controls and Shortcuts
- Options and Settings
- Supported Formats
- Troubleshooting and FAQ
Developers
RulZ Image Crawler
Getting started
Using the app
Help
RulZ Image Preparer
Getting started
Using the app
Reference
RulZ Image Grid
Using the app
Help
RulZ Huggingface Manager
Using the app
Help
RulZ Simple Video Clip Extractor
Getting started
User guide
- Playback and Marks
- Fixed-Length Clips
- Exporting
- Crop, Rotate and Flip
- Colour Matching
- Distortion Repair
- Preferences and Themes
Help