✓ 2,847 functions across 91 files parsed
✓ Graph: 3,201 nodes, 9,442 edges
✓ 8 modules auto-detected
✓ SHA-256 Merkle tree complete
✓ mikk.lock.json written
✓ claude.md + AGENTS.md written
Done in 2.8s.

Review generated files

mikk.json

mikk.lock.json

claude.md

AGENTS.md

File	Description	Commit?
`mikk.json`	Architecture contract — modules, constraints, ADRs, policies	✅ Yes
`mikk.lock.json`	Full codebase snapshot with Merkle hashes	✅ Yes
`claude.md`	AI context for Claude	✅ Yes
`AGENTS.md`	AI context for Codex and other agents	✅ Yes
`.mikk/sync-state.json`	Watcher daemon state	❌ No

Define your policies (optional)

Open mikk.json and add a policies block to configure safety gate thresholds:

mikk.json

{
  "policies": {
    "maxRiskScore": 70,
    "maxImpactNodes": 10,
    "protectedModules": ["auth", "billing"],
    "enforceStrictBoundaries": false,
    "requireTestsForChangedFiles": true,
    "requireDocumentationForApiChanges": false
  }
}

These control what the Decision Engine blocks vs. warns vs. approves. All fields have safe defaults — the block is optional.

Ignore Files

Create .mikkignore at your project root — same syntax as .gitignore:

.mikkignore

node_modules/
dist/
.next/
build/
*.test.ts
*.spec.ts
coverage/

Mikk automatically respects .gitignore. You only need .mikkignore for additional exclusions specific to Mikk.

Connect to Your AI Assistant

Add to %APPDATA%\Claude\claude_desktop_config.json (Windows) or ~/Library/Application Support/Claude/claude_desktop_config.json (macOS):

claude_desktop_config.json

{
  "mcpServers": {
    "mikk": {
      "command": "npx",
      "args": ["-y", "@getmikk/mcp-server", "/absolute/path/to/my-project"]
    }
  }
}

Or use the auto-installer:

mikk mcp install --tool claude

Add to .cursor/mcp.json in your project root:

.cursor/mcp.json

{
  "mcpServers": {
    "mikk": {
      "command": "npx",
      "args": ["-y", "@getmikk/mcp-server", "/absolute/path/to/my-project"]
    }
  }
}

Or:

mikk mcp install --tool cursor

mikk mcp install --tool vscode

Adds Mikk's MCP server to VS Code settings automatically.

Daily Workflow

# After making code changes — update the lock file
mikk analyze

# Keep a live watcher running in the background
mikk watch

# See blast radius before touching a file
mikk context impact src/auth/login.ts

# Pre-flight a refactor idea
mikk intent "Extract shared validation into a utils module"

# Validate architecture in CI
mikk ci --strict

Supported Languages

Language	Extensions	Parser	Coverage
TypeScript	`.ts`, `.tsx`	OXC (Rust)	100%
JavaScript	`.js`, `.jsx`, `.mjs`, `.cjs`	OXC (Rust)	100%
Go	`.go`	Native	100%
Python	`.py`	Tree-sitter	95%
Java / Kotlin	`.java`, `.kt`, `.kts`	Tree-sitter	90%
C#	`.cs`	Tree-sitter	90%
Rust	`.rs`	Tree-sitter	85%
C++	`.cpp`, `.cc`, `.cxx`, `.hpp`, `.hxx`, `.hh`	Tree-sitter	85%
C	`.c`, `.h`	Tree-sitter	85%
PHP	`.php`	Tree-sitter	85%
Ruby	`.rb`	Tree-sitter	85%
Swift	`.swift`	Tree-sitter	80%

Tree-sitter languages require the web-tree-sitter package, which is installed automatically with @getmikk/cli. Optional: install @xenova/transformers (22MB, downloads once) to enable mikk_semantic_search.

Was this page helpful?

Installation & Quick Start

Requirements

Node.js ≥ 18 or Bun ≥ 1.x

TypeScript, JavaScript, Go, or any of 11 supported languages

Install the CLI

Initialize Your Project

Navigate to your project root

Run mikk init