CODYGIENE

Getting Started with CODYGIENE

This guide takes you from zero to your first scan in a few minutes.

What is CODYGIENE?

CODYGIENE is an independent quality control engine that analyzes your source code locally. It checks for security issues, performance problems, code health, and AI-quality concerns across JavaScript, TypeScript, SQL, and modern frameworks like Next.js, Supabase, Prisma, and Drizzle.

Does my code leave my machine?

No. CODYGIENE performs all analysis locally. The scanner:

  • Does not upload source code or snippets
  • Does not connect to external services during scanning
  • Does not require an account or login
  • Does not send telemetry or analytics

You can verify this by monitoring network activity during a scan.

Prerequisites

  • Node.js 20 or later
  • A JavaScript/TypeScript project (Next.js, Node.js, or similar)

Install

npm install -g codygiene@beta

Verify the installation:

codygiene --version

You should see the CLI, engine, and ruleset versions.

Run your first scan

Navigate to your project:

cd my-project

Run a scan:

codygiene scan

CODYGIENE will discover all supported files, analyze them locally, and print a report to your terminal.

Understand the result

The terminal output shows:

  1. Repository · the scanned path
  2. Frameworks · detected technologies (Next.js, Supabase, etc.)
  3. Coverage · how many files were discovered, analyzed, and whether the scan was COMPLETE or PARTIAL
  4. Scores · overall score plus per-category scores (Security, Performance, Code Health, AI Quality)
  5. Findings · prioritized list of issues, grouped by severity

A COMPLETE scan means all eligible files were analyzed. A PARTIAL scan means some files were skipped · the scores may not represent the full repository.

Export a report

For CI/CD or sharing:

codygiene scan --format json -o report.json
codygiene scan --format sarif -o report.sarif
codygiene scan --format markdown -o report.md

Machine-readable reports (JSON, SARIF, Markdown) contain all findings. The terminal output shows a prioritized subset for readability.

Where to go next