Documentation

Learn how to use ScanoRepo to audit your repositories and generate documentation with AI.

Installation

Install ScanoRepo globally via npm to use it anywhere in your terminal.

$ npm install -g scanorepo

Project Scanning

Audit your project for configuration issues, missing scripts, and environment variables.

$ sr scan

Auto Documentation

Generate a professional SCANNED.md file summarizing your project's architecture.

$ sr doc

Dependency Audit

Launch an interactive interface to manage and audit your project packages.

$ sr deps

Health Check

Run a comprehensive health check (sequential execution of scan and doc).

$ sr check

AI-Driven Insights

ScanoRepo uses a secure proxy to connect to high-performance inference models. No personal API keys are required. The AI analyzes your project's unique structure to provide technical explanations for every issue detected.