Skip to content

brunozarate-23/ren-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Ren CLI

Ren is a local-first CLI that reviews a repository and produces a structured code quality report. It behaves like a lightweight staff engineer pass over an existing codebase: it inspects the filesystem, detects the stack, runs deterministic reviewers, prints a terminal summary, and saves a JSON report.

What Ren checks

Ren currently reviews repositories across five areas:

  • Architecture: large folders and large source files
  • Maintainability: large files, repeated file names, and TODO-style markers
  • Documentation: README, setup guidance, and environment configuration notes
  • Security: obvious hardcoded secret patterns
  • Performance: dependency and bundle-related signals

Findings are conservative by default. The goal is useful signal, not noisy lint output.

Quick start

From this repository, run Ren against any local project:

npx tsx src/index.ts review /path/to/project

Example:

npx tsx src/index.ts review .

Ren prints a summary and writes the full report to:

.ren/reports/review.json

Commands

Review a repository

npx tsx src/index.ts review /path/to/project

Runs the full deterministic review pipeline and saves a JSON report in the target repository.

Detect a stack

npx tsx src/index.ts stack /path/to/project

Displays detected languages, frameworks, runtimes, package managers, and tools.

Show the latest report

npx tsx src/index.ts report /path/to/project

Reads .ren/reports/review.json from the target repository and prints the saved summary without running reviewers again.

Report format

Each finding includes:

{
  id: string;
  title: string;
  category: string;
  severity: 'critical' | 'high' | 'medium' | 'low';
  confidence: 'high' | 'medium' | 'low';
  evidence: string;
  recommendation: string;
}

Development

Install dependencies:

npm install

Typecheck:

npx tsc --noEmit

Run the CLI during development:

npx tsx src/index.ts review .
npx tsx src/index.ts stack .
npx tsx src/index.ts report .

Build:

npm run build

Project direction

The first milestone is a useful local command:

ren review .

About

Ren is a local-first AI engineering companion that reviews existing repositories and helps developers improve code quality, maintainability, architecture, documentation, and security.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors