Skip to main content

Engineering-first repository reconnaissance and architectural auditing.

Project description

🔍 CodeRecon

CodeRecon Logo

Engineering-first repository reconnaissance and architectural auditing.

CodeRecon is a pragmatic CLI tool designed to bridge the gap between documentation and reality. It performs deep static analysis of codebases to identify functional mapping, architectural risks, and implementation gaps using local intelligence.


Architecture Guide – Deep dive into the system design and AST parsing logic.

CodeRecon Demo - Click to watch the engineering-first reconnaissance workflow in action.

🚀 Installation

1. From PyPI

Install the core tool directly via pip:

pip install coderecon

2. Local LLM Setup

CodeRecon requires Ollama for its reasoning capabilities.

Download Ollama from ollama.com.

Pull the required model:

ollama pull llama3

🛠️ Usage

Quick Start Analyze your current directory and get a structural breakdown:

coderecon explain .

Architectural Mapping Generate a topology map to see functional roles and risk density:

coderecon topology .

Formal Audit

Generate a persistent RECON_REPORT.md with technical specs and Mermaid diagrams:

coderecon report .

Remote Audit

Analyze a GitHub repository without cloning it manually:

coderecon explain [https://github.com/user/project](https://github.com/user/project)

Help Menu

Gives an entire menu of the available commands and functions and their purposes:

coderecon help

🏗️ Architectural Bucketing

The tool automatically classifies files into functional roles:

Entry Points: System dispatchers and main hooks.

Core: High-logic modules with central dependencies.

Data Layer: Schemas, models, and database logic.

External Integrations: API clients and LLM wrappers.

Utilities: Helper modules and reporting logic.

🔌 Architecture & Extensibility (MCP)

CodeRecon is built on the Model Context Protocol (MCP). While primarily a CLI tool, its internal engine functions as an MCP server.

  • Standardized Context: Uses fastmcp to bridge local AST analysis with LLM reasoning.
  • Tool-Agnostic: Because it follows the MCP standard, CodeRecon’s analysis logic can be plugged into any MCP-compliant host (like Claude Desktop or IDE agents) in the future.
  • Local-First Protocol: MCP ensures that the communication between the scanner and the LLM happens entirely on your machine.

🛡️ Privacy & Philosophy

100% Local: Your code never leaves your machine. Analysis is performed via local AST parsing and local LLM inference.

No-Cap: Prioritizes hard file data over AI "guesses."

Ephemeral: Remote clones are stored in temp directories and aggressively deleted after use.

Generated by CodeRecon — Local & Private Intelligence.


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

coderecon-0.1.5.tar.gz (17.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

coderecon-0.1.5-py3-none-any.whl (20.5 kB view details)

Uploaded Python 3

File details

Details for the file coderecon-0.1.5.tar.gz.

File metadata

  • Download URL: coderecon-0.1.5.tar.gz
  • Upload date:
  • Size: 17.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.19

File hashes

Hashes for coderecon-0.1.5.tar.gz
Algorithm Hash digest
SHA256 3305934b155ab3dd12c30e4c5e727affc93b50a14f7733c2a85971365fc0fb83
MD5 a92e53a3edf75236ff022d9316c50da3
BLAKE2b-256 0df6bb2d946410d181c978062c99371b7af5cd445567096d4a3a75bc75019014

See more details on using hashes here.

File details

Details for the file coderecon-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: coderecon-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 20.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.19

File hashes

Hashes for coderecon-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 3dc48d5a7d9bef46f220f9565d7a3c332c6a112b3a9e9d472648c3dfb5a16724
MD5 f5ae215e3bea6d5e42cae1b65ca2acbd
BLAKE2b-256 8a34183ba02a0a627bacf106cdce26d8efe9a87a8f2014e4ebb3f6875e190fce

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page