Reference

Documentation

How to measure a project and read a run, the spells, the outcomes and the score, the configuration, CI, agents and every kalku command.

Getting started

Installation: Install kalku with Homebrew, from a release or from source.
Measure a project: The first run, with nothing set up, and how to keep kalku in a project with kalku init.
What a run tells you: How to read the report: survivors first, the score after, and the four output formats.
Configuration: The .kalku.toml file, the .kalku/ folder and what each key means.

How it works: The four stages of a run: baseline, plan, cast and report, and why warm workers are the point.
Spells: The kinds of defect kalku casts, what each one simulates and the forms it takes in each language.
Outcomes and score: What a cast can come to, which outcomes go into the score and which are reported apart.
Equivalent mutants: What to do with a wekufe no test can kill: the .kalku/equivalent file and why an agent can only propose.

In CI: Gate a pull request on the holes it introduced with --since, and the global score with a nightly run.
For coding agents: The loop kalku is built for: find a survivor, write a test, re-cast, repeat.
MCP server: kalku mcp serves the four agent tools over stdio: how to install it in your host and what each one does.
Keep it warm: kalku serve keeps the kalku a project was measured with, so the next run casts over a warm one.

kalku run: Casts wekufe over some files and reports the survivors.
kalku cast: Re-casts a wekufe after a test was written, to learn whether it is dead now.
kalku show: One wekufe in full: site, diff, covering tests, hint and history.
kalku init: Keeps kalku in a project: detects the language and writes .kalku.toml and .kalku/summon.
kalku info: What kalku knows about spells, outcomes, formats and agents, documented from the binary itself.
kalku propose-equivalent: Proposes a wekufe as equivalent, with its reason; kalku accept and kalku reject are a person's answer.

Languages: The languages kalku measures today and how the kalku of each one works.
What works today: kalku is pre-alpha: which pieces are done and which are not yet.
The cast: What kalku, wekufe, kalkutun and reni mean, where they come from and what each word names in the tool.