Get Mikk running in your project in under 3 minutes — install the CLI, run mikk init, and connect your AI assistant.

Requirements

Node.js ≥ 18 or Bun ≥ 1.x

Any modern Node runtime works. Bun is faster for global installs.

TypeScript, JavaScript, or Go project

Any project with .ts, .tsx, .js, .jsx, or .go files.

Install the CLI

npm install -g @getmikk/cli

bun add -g @getmikk/cli

# No install needed — run directly
npx @getmikk/cli init

Verify the installation:

mikk --version
# 1.7.0

Initialize Your Project

Navigate to your project root

cd my-project

Run mikk init

mikk init

Mikk scans your codebase and writes all artifacts in ~3 seconds:

✓ 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  (−60% vs raw source)
✓ .mikk/diagrams/ written (8 Mermaid files)
✓ claude.md + AGENTS.md written
Done in 3.1s.

Review generated files

mikk.json

mikk.lock.json

claude.md

AGENTS.md

hashes.db

File	Description	Commit?
`mikk.json`	Architecture contract — edit to define modules and constraints	✅ 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/diagrams/`	8 Mermaid architecture diagrams	Optional
`.mikk/hashes.db`	SQLite Merkle hash store	❌ No

Ignore Files

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

.mikkignore

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

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

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

This adds the MCP server configuration to VS Code's settings automatically.

Daily Workflow

# After making code changes
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 contract validate --strict

Supported Languages

Language	Extensions	Parser
TypeScript	`.ts`, `.tsx`	TypeScript Compiler API
JavaScript	`.js`, `.jsx`, `.mjs`, `.cjs`	TypeScript Compiler API
Go	`.go`	Regex + stateful scanning

Go support uses regex-based scanning, not a full AST parser. Function signatures and imports are captured accurately, but complex Go generics may not be fully resolved.

Was this page helpful?

Installation & Quick Start