Skip to main content

Engineering-first repository reconnaissance and architectural auditing.

Project description

🔍 CodeRecon

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.


🚀 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)

🏗️ 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.

🛡️ 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.2.tar.gz (16.2 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.2-py3-none-any.whl (20.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: coderecon-0.1.2.tar.gz
  • Upload date:
  • Size: 16.2 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.2.tar.gz
Algorithm Hash digest
SHA256 3534974590ca770e6db935f4eeb1cd5d622f2687a4695ab1b0f3e3ed65d3437b
MD5 9da6f19978ffe651383bde1193a40403
BLAKE2b-256 7e108f857b1b553ee5cc6c6cac95acc9b3af505f8103c8d96f21f5824b6403a1

See more details on using hashes here.

File details

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

File metadata

  • Download URL: coderecon-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 20.2 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 532d3361f3f693a494ab7f0b8b8bae679248729e412f3965a1c8e2b2a28348f2
MD5 fe76c8324aabc0d72438665521b68435
BLAKE2b-256 08bbca35f3bed4529e9738be4a65ea1e97a303eaa9e40966261f1380d9d1e550

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