read-code

Install Globally

npm install -g read-code

Install In A Project

npm install read-code

Verify Installation

read-code --help

🚀 read-code

Turn Any Codebase Into AI Context

read-code is an advanced code intelligence engine that scans entire projects, understands architecture, extracts relationships, builds knowledge graphs, and generates AI-ready JSON context.

Instead of uploading hundreds of files and repeatedly explaining your project to AI, simply run:

read-code scan

and upload the generated JSON.

👨‍💻 Author

Risk Chips

Why read-code?

Normally:

Upload project
Explain architecture
Explain database
Explain routes
Explain auth
Explain features
Repeat every conversation

With read-code:

read-code scan
↓
Generate AI Context
↓
Upload JSON
↓
AI Understands Project

Supported Technologies

JavaScript

function login() {}

TypeScript

interface User {}

React

function Navbar() {}

JSX

<App />

TSX

<App />

Core Features

Project Scanner

Scans:

.js
.ts
.jsx
.tsx
.json
.md

Builds:

Project Tree
Statistics
Framework Detection
AI Context

JavaScript Intelligence

Extracts:

Functions
Classes
Imports
Exports
Arrow Functions

TypeScript Intelligence

Extracts:

Interfaces
Types
Enums

React Intelligence

Extracts:

Components
Hooks
Props
Routes

Symbol Intelligence

Builds a project-wide symbol table.

Example:

{
  "login": {
    "type": "function",
    "file": "src/auth/login.js",
    "startLine": 12,
    "endLine": 48
  }
}

Detects:

Functions
Classes
Components
Interfaces
Types
Enums

Source Snippet Extraction

Stores implementation snippets.

Example:

{
  "name": "login",
  "snippet": "async function login(req,res){...}"
}

This dramatically improves:

Bug Fixing
Refactoring
Code Understanding
AI Reasoning

Graph Engine

Dependency Graph

File → Imports

Call Graph

Function → Function

Component Graph

Component → Component

Knowledge Graph

Project → Relationships

Architecture Analysis

Detects:

MVC
Repository Pattern
Service Pattern
Layered Architecture
Component Architecture

Database Detection

Detects:

MongoDB
PostgreSQL
MySQL
SQLite
Redis

ORM Detection

Detects:

Prisma
Mongoose
Sequelize
TypeORM

Authentication Detection

Detects:

JWT
Passport
OAuth
Session Auth

Feature Detection

Automatically discovers:

Authentication
Dashboard
Messaging
Notifications
Payments
Admin Panels
File Uploads
Search

AI Context Engine

Generates:

{
  "project": {},
  "frameworks": [],
  "statistics": {},
  "tree": {},
  "analysis": {},
  "graphs": {},
  "analyzers": {},
  "symbols": {}
}

Perfect for:

AI Agents
Code Reviews
Architecture Reviews
Documentation
Bug Fixing
Refactoring
Project Understanding

Commands

Scan Project

read-code scan

Creates:

.read-code/latest.json

Save Output

read-code scan --savefile project.json

Compact Output

read-code scan --compact

Produces minified JSON.

Exclude Folders

read-code scan --exclude tests,docs

Example:

read-code scan --exclude tests,docs,coverage

Combine Multiple Flags

read-code scan --savefile project.json --compact

read-code scan --exclude tests,docs --compact

read-code scan --exclude tests,docs --compact --savefile output.json

Flags work in any order.

Query Project

read-code query "what frameworks are used"

Examples:

read-code query "show architecture"

read-code query "what routes exist"

read-code query "what features exist"

read-code query "where is login"

read-code query "show code for login"

read-code query "jwt"

read-code query "prisma"

Explain Project

read-code explain

Help

read-code --help

Generated Files

Automatic Cache

.read-code/
└── latest.json

Generated automatically after every scan.

Custom Output

read-code scan --savefile project.json

Creates:

project.json

Example Workflow

Generate context:

read-code scan --savefile project.json

Upload:

project.json

Ask AI:

Explain architecture

Find JWT validation

Show login implementation

Locate Prisma usage

Find authentication flow

Suggest refactoring opportunities

Find database entry points

Identify dead code

Current Capability

| Capability | Accuracy | | -------------------------- | -------- | | Project Understanding | 98% | | Architecture Understanding | 98% | | Documentation Generation | 98% | | Dependency Analysis | 95% | | Code Search | 90% | | Refactoring Assistance | 80% | | Bug Localization | 75% | | AI Readiness | 85% |

Roadmap

Quality Analysis

Dead Code Detection
Circular Dependency Detection
Duplicate Code Detection

Advanced Intelligence

Cross File Symbol Tracking
Reference Tracking
Variable Usage Analysis
Data Flow Analysis
Control Flow Analysis

AI Enhancements

Context Compression
Semantic Search
Embeddings
AI Memory Packs
Automatic Refactoring Plans

License

MIT License

Copyright (c) 2026 Risk Chips