Quickstart

Initialize, index, inspect, validate.

Install mdkg, then keep the first path intentionally small. It proves mdkg is installed, creates repo-local project memory, builds the index cache, and verifies graph health.

Install and first run

npm install -g mdkg
mdkg --version
mdkg init --agent
mdkg index
mdkg status
mdkg validate

Node requirement

mdkg uses modern Node capabilities. Install Node 24.15.0 or newer before the global npm install.

node --version

Start small

Run the first pass on a small repo or a fresh branch so graph memory files, agent docs, and generated indexes are easy to review.

git status --short

Agent handoff

Then run the Plan -> Work -> Evidence loop.

After initialization, use the graph to select work and build deterministic context. Replace `GOAL_ID`, `WORK_ID`, and `TASK_ID` with real ids from your repo.

First agent loop

mdkg goal current
mdkg goal next GOAL_ID
mdkg show WORK_ID
mdkg pack WORK_ID --pack-profile concise
mdkg handoff create WORK_ID
mdkg task done TASK_ID --checkpoint "Meaningful milestone"
mdkg validate

Success signals

What good looks like after five minutes.

The first run should leave visible, reviewable repo state rather than a hidden service or transient chat instruction.

Scaffolded memory

A `.mdkg/` folder, agent startup docs, and core project memory conventions are present.

.mdkg/

Rebuildable access

The index is generated from source files and can be rebuilt when graph files change.

mdkg index

Clean validation

Validation explains missing refs, stale state, and template issues before closeout.

mdkg validate --summary