Skip to content

Repository files navigation

🧠 CodeMRI

The Offline-First Neural Repository Intelligence Platform

"GitHub shows your syntax and file lists. CodeMRI reveals how your software actually thinks and executes."

Version Live Web Docs Engine: Full Spectrum Privacy: 100% Offline License: Apache 2.0 Support & Donate: Saweria


[!IMPORTANT]
🌐 Live Interactive Web Documentation & Get Started Guide:
Looking for step-by-step usage tutorials, interactive architecture demos, and practical CLI command examples? Visit our official serverless Web Guide at codemri.vercel.app!

Don't clone our tool. Just install once, navigate into any complex repository, and type one word:
codemri


⚡ What is CodeMRI?

Modern enterprise software repositories contain thousands of files, hidden dependencies, undocumented architectures, and tangled execution flows. Engineers waste hours or days attempting to comprehend unfamiliar repositories before writing a single line of code. Traditional AI assistants act as blind text predictors—generating boilerplate without understanding your architecture as a living system.

CodeMRI works like an automated medical MRI scan for your codebase. In under 60 seconds and entirely offline, it compiles your raw code into an indexed Neural Repository Graph (NRG) powered by an embedded pure-Go SQLite relational engine. It launches an interactive visual dashboard in your browser instantly—giving you superpowers to understand architectures, dependency bottlenecks, and AI reasoning insights without leaking a single byte of code to cloud endpoints.


📦 Zero-Friction Installation & Quickstart

We deliberately chose a Native Go Binary distribution over cumbersome NPM global installations or complex repository clones. No Node.js required. No JVM required. Launches in less than 5 milliseconds.

1. Install Global Binary (Pick Your OS)

Platform Recommended Command Alternative
🪟 Windows winget install codemri scoop install codemri
🍏 macOS brew install codemri curl -fsSL https://codemri.dev/install.sh | sh
🐧 Linux curl -fsSL https://codemri.dev/install.sh | sh Download .tar.gz from GitHub Releases
🐹 Go Developers go install github.com/KangBasrengg/MRI-Code/cmd/codemri@latest Requires Go 1.22+

2. The "One-Word" Killer Workflow

Once installed, you never need to configure complex YAML files or clone tools again. Whenever you encounter an unfamiliar codebase or want to inspect your current software, follow this 3-step muscle memory:

# 1. Navigate to ANY target project directory on your computer
cd my-unfamiliar-monorepo

# 2. Execute the one-word intelligence engine
codemri

# 3. ☕ Sit back! CodeMRI scans syntax, indexes SQLite dependencies, and launches your visual dashboard automatically!

💎 Features & Architecture Highlights (v1.0.0 MRI Enterprise Release)

  • 🤖 Cortex AI Copilot (Offline vs. Online AI Mode): Ask natural language questions about your repository structure using codemri explain or via the persistent Floating Chat Bubble inside the analyzer web UI.
    • 🌐 Online AI Model Enrichment (--online): Natively integrates with freemodel.dev API models to provide deep conversational architectural analysis enriched by local graph structural context.
    • 🔒 Strict Zero-Cloud Privacy Lock (--offline): Enforced local processing with codemri --offline. Disables all cloud transmissions and computes answers exclusively over local SQLite structural topology (ADR-0002 compliant).
  • 🕸️ Interactive Force-Directed Topology Canvas: Introduces a 60FPS physics-driven graph visualization at localhost:4000. Click any symbol node to instantly compute its architectural impact radius, upstream callers, and downstream dependencies.
  • 💓 Pulse — Tech Debt & Health Scoring: Algorithmically computes an overall repository letter grade (A+ to F), isolates uncalled dead code symbols, and exposes circular package import chains instantly using codemri analyze ..
  • 🛡️ Shield — Security & Secret Diagnostics: Multi-layered security intelligence scanning for hardcoded API keys, JWTs, XSS vulnerabilities (innerHTML), SQL injections, and dependency risks with actionable remediation advice.
  • 🚀 Velocity — Performance & Footprint Profiling: Identifies packaging compilation bottlenecks, bloated source files (>50KB), heavy standard library dependency chains, and optimization targets.
  • 💾 Sub-Millisecond Relational SQLite Engine: Powered by a pure-Go embedded SQLite graph database (.codemri/graph.db). Query dependencies and architectural bonds across 100k+ lines of code in sub-millisecond latencies.
  • 🔍 Universal Deterministic Syntax Parser: Multi-language AST classification supporting Go, TypeScript, JavaScript, Python, Java, PHP, Rust, SQL, HTML, CSS, and Docker without external runtime SDKs.
  • 🩺 Environmental Diagnostics & Port Guard: Verify system readiness anytime with a single diagnostic run:
    codemri doctor

🗺️ Engineering Roadmap & Release Progress

CodeMRI follows strict iterative engineering discipline where every release represents a monumental structural breakthrough:

Version Codename Primary Focus Status Specification
v0.1.0 🌟 Genesis Monorepo architecture, CLI foundational engine, interface contracts ✅ RELEASED Read Spec
v0.2.0 🗺️ Atlas High-speed concurrent worker pools, multi-language syntax AST parsing ✅ RELEASED Read Spec
v0.3.0 🧠 Neuron CGO-free embedded SQLite relational graph indexing (graph.db), API querying ✅ RELEASED Read Spec
v0.4.0 💓 Pulse Dead code discovery, circular dependency loops, complexity & repository health scoring ✅ RELEASED Read Spec
v0.5.0 👁️ Vision Interactive force-directed topology canvas & instant impact analysis engine ✅ RELEASED Read Spec
v0.6.0 Cortex Offline AI reasoning engine — codemri explain natural language queries ✅ RELEASED Read Spec
v0.7.0 🛡️ Shield Security intelligence — secrets detection, SQLi/XSS/CSRF scanning ✅ RELEASED Read Spec
v0.8.0 🚀 Velocity Performance intelligence — large files, heavy imports, duplicate packages ✅ RELEASED Read Spec
v0.9.0 🔨 Forge Plugin extensibility foundation — terminal graph queries, JSON API contracts ✅ RELEASED Read Spec
v1.0.0 🎉 MRI Stable worldwide production enterprise release 🌟 STABLE RELEASE Read Spec

🏛️ Documentation & Manifesto

We believe in absolute transparency and building developer understanding over mindless code generation:


🤝 Contributing & Community

CodeMRI is licensed under the commercial-friendly Apache 2.0 License, guaranteeing complete patent security and free forever usage of the core CLI engine. Contributions, feature suggestions, and bug reports are warmly welcomed!

  1. Read our Contributing Guide for setup, coding standards, and commit conventions.
  2. Use our Issue Templates to report bugs, request features, or ask questions.
  3. Check the Pull Request Guidelines.
  4. Fork the repository, build from source with make build or go test ./..., and submit your PR!

💖 Sponsor & Support the Project

CodeMRI is engineered with intense dedication, thousands of lines of CGO-free performance discipline, and an unconditional commitment to developers worldwide. If this tool saves your engineering team time, simplifies complex codebase analysis, or enhances your architecture workflows, please consider showing your appreciation to Muhammad Nuril (KangBasrengg) via Saweria:


Support & Donate on Saweria

Every contribution directly catalyzes future open-source innovation, new structural AI enhancements, and ongoing project maintenance. Thank you deeply for your support! ❤️



Made with passion and zero-dependency discipline by Muhammad Nuril (KangBasrengg) and the CodeMRI Open Source Community.

About

CodeMRI reveals how your software actually thinks and executes

Resources

Contributing

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages