@getmikk/cli 1.8.2 → 2.0.0

package/README.md

@@ -39,6 +39,30 @@ mikk init
 # 8. Generate claude.md and AGENTS.md
 ```
 
+---
+ 
+## Professional CLI snapshot
+
+`mikk init --force` now emits a structured **Project snapshot** panel (files, nodes, edges, functions, exports, modules) followed by the top module coordinates and a **Context & schema files** panel so you can review the analysis without hunting through logs.
+
+```
+  ┌─ Project snapshot ─────────────────────────────────────────────────────────┐
+  │ Files         181                                                          │
+  │ Graph nodes   3716                                                         │
+  │ Graph edges   3611                                                         │
+  │ Functions     213                                                          │
+  │ Exported APIs 79                                                           │
+  │ Modules       1                                                            │
+  └────────────────────────────────────────────────────────────────────────────┘
+  █  Graph density  0.97 edges/node
+```
+
+The human-friendly digest makes it easy to confirm the graph scale before drilling into modules, contexts, or constraints.
+
+## Benchmark note (GitNexus)
+
+We attempted to benchmark against GitNexus (`npx --yes --package gitnexus gitnexus analyze`) but the CLI install is blocked inside this sandbox: npm raises `EACCES` while fetching `gitnexus` (error: `FetchError: request to https://registry.npmjs.org/gitnexus failed`). Once the platform permissions allow installing npm packages you can rerun the command to capture the repo metrics.
+
 ---
 
 ## Commands
@@ -137,20 +161,16 @@ mikk contract validate --strict
   run: mikk contract validate --boundaries-only --strict
 ```
 
-#### `mikk contract generate`
-
-Regenerate the `mikk.json` skeleton from the current codebase. Useful after major refactoring.
-
-```bash
-mikk contract generate
-```
+#### Contract regeneration
 
-#### `mikk contract update`
+Mikk regenerates `mikk.json` / `mikk.lock.json` as part of:
 
-Update the lock file to match the current codebase state.
+- `mikk init` (full project scan + artifacts generation)
+- `mikk analyze` (re-analyze + update generated artifacts)
 
 ```bash
-mikk contract update
+mikk init
+mikk analyze
 ```
 
 #### `mikk contract show-boundaries`
@@ -299,19 +319,19 @@ Regenerate the diagram for a specific module.
 mikk visualize module auth
 ```
 
-#### `mikk visualize impact`
+#### `mikk context impact`
 
-Generate an impact diagram based on current file changes (files that differ from the lock file).
+Analyze what breaks if a specific file changes (and includes an AI-context-focused impacted view).
 
 ```bash
-mikk visualize impact
+mikk context impact src/auth/login.ts
 ```
 
 ---
 
 ### `mikk mcp` — MCP Server for AI Assistants
 
-Connect your project architecture to Claude Desktop, Cursor, VS Code, or any MCP-compatible AI tool. The MCP server exposes 15 tools and 3 resources for your assistant, all powered by the Mikk lock file.
+Connect your project architecture to Claude Desktop, Cursor, VS Code, or any MCP-compatible AI tool. The MCP server exposes 22 tools and 3 resources for your assistant, all powered by the Mikk lock file.
 
 #### `mikk mcp` (default: start server)