Reference

Commands

Every Okulo command, with practical examples. Use the submenu to open a detailed page, or browse the catalog below.

Quick start recipes

okulo log -w 6m
okulo hotspots -w 6m -n 15
okulo debt --hourly-rate 60 --currency EUR
okulo refactor --top 5
okulo check --base main -f markdown -o okulo-pr.md

Catalog

okulo logSummarize the Git history Okulo will analyze — commits, authors, files, and date range. okulo componentsList architecture layers and directory components — the names you pass to --components. okulo hotspotsRank files by change frequency × complexity — where cleanup usually pays back. okulo trendTrack code health over time for hotspots or specific files — is it getting worse? okulo debtSeparate active vs inactive debt and estimate hours (and money) you are losing. okulo refactorTurn active debt into a function- and line-level refactor plan. okulo couplingFind files or components that change together — including hidden, import-free coupling. okulo authorsUnify developer identities and suggest aliases for .okulo.toml. okulo ownershipShow who knows each file and highlight knowledge islands. okulo busfactorEstimate how many departures the repo (or each component) can absorb before knowledge collapses. okulo peoplePer-person churn, knowledge share, and impact if they become inactive. okulo coordinationSee which people and teams touch the same components — coordination pressure. okulo mapHierarchical map of the codebase: size × hotspots × health (terminal or HTML). okulo checkQuality gate for a PR, staged changes, or the working tree — fail when hot code gets worse. okulo hookInstall or remove a Git pre-commit hook that runs okulo check --staged. okulo analyzeRun the major analyses together — ideal for JSON exports and agent workflows. okulo webOpen a local multi-project web UI on a free port. okulo mcpStart an MCP server over stdio so coding agents can call Okulo as tools.

Common options

Most analysis commands accept:

Option	Default	Description
`-w, --window`	`12m`	History window
`-f, --format`	`table`	`table`, `json`, `markdown`
`-o, --output`	—	Write to a file
`-n, --limit`	`20`	Rows to show
`--components A,B`	all	Scope to components from `okulo components`
`--exclude GLOB`	—	Extra path excludes (repeatable)