enolaDocsFive-minute quickstart

Documentation

Five-minute quickstart

Install Enola, record the current architecture, make one change, and compare the result.

01 · Install

Install the binary

macOS and Linuxshell
curl -fsSL https://raw.githubusercontent.com/enola-labs/enola/main/install.sh | sh
enola --version

The installer verifies the release checksum and writes the binary to ~/.local/bin. Add that directory to PATH if your shell cannot find enola.

Alternative installs: pip install enola-cli, the enola RubyGem, or a verified archive from the latest GitHub release.

02 · Inspect

Run the first analysis

From a repository root, print a report without writing snapshot files:

Read-only reportshell
enola --explain .

The report lists detected languages, extracted structure, and architectural findings. Detection is automatic; a configuration file is not required.

03 · Baseline

Record the before state

Repository rootshell
enola baseline pin

This creates the snapshot that later checks use as the comparison point. Keep the extraction settings unchanged between the baseline and the check.

04 · Change

Make a small code change

Add or remove an import, call, route, or dependency in a part of the repository you can safely edit. Enola compares structure, so a comment-only change may produce no architecture delta.

05 · Compare

Check the result

Compare with the baselineshell
enola check

With no --fail-on policy, new findings are reported but do not fail the command. Add a category only when you want that category to produce exit code 1.

No delta is a valid result. It means the edit did not change any structure detected by the active extractors.

06 · Dashboard

Open the local dashboard

Latest snapshotshell
enola dashboard --open

The dashboard is read-only and runs on a loopback address. Stop it with Ctrl-C. Continue with the dashboard guide.

07 · Agent

Connect an MCP client

The CLI workflow above works without an agent. To expose the same graph tools through MCP, register the local command with your client:

Claude Codeshell
claude mcp add enola enola
Codexshell
codex mcp add enola -- enola

Cursor uses an mcp.json entry whose command is enola; enola install registers opencode for you. Run enola install --hooks if you also want supported agents to pin and check automatically; the installer previews changes before writing.

08 · Next

Continue from the result