scanorepo
v1.0.4
Published
Cross-platform AI-powered CLI tool for project scanning and documentation
Maintainers
Readme
ScanoRepo
AI-powered CLI tool for project scanning and documentation generation.
ScanoRepo is a cross-platform command-line utility built with Node.js and TypeScript. It is designed to audit JavaScript and TypeScript repositories for configuration issues and generate comprehensive project documentation using AI-driven insights.
Official Website: scano-repo-gui.vercel.app
Features
- Project Scanning - Analyzes repositories for missing npm scripts, environment variables, dependencies, and TypeScript configuration discrepancies.
- AI-Powered Insights - Utilizes Groq's high-performance inference engine to provide technical explanations and recommended solutions for detected issues.
- Automated Documentation - Generates a structured
SCANNED.mdfile summarizing project architecture, key components, and deployment procedures. - Dependency Management - Provides an interactive interface to install, update, and audit project packages.
- Cross-Platform Compatibility - Fully supported on Windows, macOS, and Linux environments.
Installation
Global Installation
npm install -g scanorepoLocal Development
git clone https://github.com/classicManCode/ScanoRepo.git
cd ScanoRepo
npm install
npm run build
npm linkZero Configuration
ScanoRepo is designed for immediate utility. Users are not required to provide personal API keys or manage complex environment variables. AI-driven analysis is facilitated through a secure proxy service maintained by the developer.
Operational Overview
- An audit command is initiated by the user.
- ScanoRepo transmits project metadata to a secure backend infrastructure.
- The backend processes the request using high-performance large language models.
- Actionable technical insights are returned directly to the terminal interface.
Usage
Navigate to the target Node.js project directory and execute:
sr <command>Available Commands
| Command | Description |
| -------------- | --------------------------------------------------------------------- |
| sr scan | Audit project for configuration issues with AI-assisted explanations. |
| sr doc | Generate SCANNED.md documentation using AI analysis. |
| sr deps | Interactive dependency management and auditing. |
| sr check | Comprehensive health check (Sequential execution of scan and doc). |
| sr --help | Display command reference. |
| sr --version | Display current version information. |
Command Details
sr scan
Performs a diagnostic audit of the project:
- Script Analysis - Verifies presence of standard scripts such as
start,dev,build, andtest. - Environment Verification - Detects absence of
.envfiles and suggests templates. - TypeScript Configuration - Identifies
.tssource files lacking an associatedtsconfig.json. - Dependency Integrity - Validates the state of the
node_modulesdirectory.
sr doc
Analyzes the repository structure to produce a professional SCANNED.md file, providing:
- Technical project overview.
- Functional breakdown of key directories and files.
- Standardized onboarding and installation instructions.
sr deps
Initiates an interactive management interface:
- Automatically detects preferred package managers (npm or yarn).
- Facilitates secure package installation, updates, and outdated package auditing.
Operational Constraints
- Node.js Environment - ScanoRepo is optimized for projects containing a valid
package.json. - Inference Variability - AI-generated explanations are intended for assistance and may vary between executions.
- Build Requirements - When modifying the source, ensure a fresh build is generated via
npm run build.
Development
Assembly
npm run buildDebugging
npm run devLocal Testing
npm link
sr scanLicense
This project is licensed under the MIT License. Refer to the LICENSE file for additional details.
Author
Benjamin Onyia
- Portfolio: benjamin-onyia.vercel.app
- GitHub: classicManCode
Developed by Benjamin Onyia.
