Get started

Install kimün and measure your first project

One binary called km, with no dependencies and no configuration.

Install

With Cargo, from crates.io:

cargo install kimun

With Homebrew, on macOS and Linux:

brew install lnds/kimun/kimun

There are also ready-made binaries for macOS (Apple Silicon), Linux (x86_64 and arm64) and Windows (x86_64) on the releases page. See the releases →

The first measurement

Go to the folder of your project and ask for the grade. Kimün respects your .gitignore and needs no git repository for static metrics.

km score
$ km score

 Project Score:  A (91.7)
 Files Analyzed: 141
 Total LOC:      19,075

 Dimension                 Weight   Score   Grade
 Cognitive Complexity         30%    84.2   B+
 Duplication                  20%   100.0   A++
 Indentation Complexity       15%    93.1   A+
 Halstead Effort              20%    87.5   A-
 File Size                    15%   100.0   A++

 Files Needing Attention
  60.7  D    src/deps/analyzer.rs      Cognitive: 36
  63.8  D+   src/cogcom/analyzer.rs    Cognitive: 35
  72.4  C    src/smells/rules.rs       Cognitive: 20

real output: kimün measuring itself

What to look at next

km hotspots
Where to improve first: complex files that change often.
km impact --since-ref main
What your branch reaches before you merge it.
km score --trend main --fail-if-worse --gate-scope changed
The gate for your continuous integration.
km ai skill claude
The skill that lets your agent use km.

Configuration

None is needed, but km init gives you a .kimun.toml calibrated for your project, where you can tune thresholds and exclusions.

km init

Full documentation

Every command has its own page, with its options and examples.

Read the documentation