🚀 scanner-skill

Welcome to the ultimate codebase blueprint for scanner-skill. This document compiles high-density specifications, dynamic routing schemes, custom styling design tokens, file topologies, repository statistics, and step-by-step extension roadmaps in a single unified entrypoint.

• Primary Ecosystem: Node.js (JS/TS)
• Total Files Count: 8 scanned files
• Combined Size: 168.7 KB

📦 Installation & Quick Start

You can run and install scanner-skill using npx or via global/local npm installations:

1. Run Instantly via npx (No Installation Needed)

To scan your current local directory and initialize the AI agent skill:

npx @sujoymoulick/scanner-skill

To scan a remote GitHub repository and launch the interactive local web dashboard:

npx @sujoymoulick/scanner-skill <github-repo-url>

2. Global Installation

To install the CLI tool globally on your system:

npm install -g @sujoymoulick/scanner-skill

Now you can execute the command from any workspace directory:

scanner-skill [path-to-file-or-dir | github-repo-url]

3. Local Dev Dependency

To integrate it directly inside an existing codebase:

npm install --save-dev @sujoymoulick/scanner-skill

And execute via:

npx scanner-skill

🌟 Discovered Architecture Layers

• 🔌 Backend Server API Layer: Implements endpoints handling routing. Detected handlers: /api/v1/health, /api/v1/health, /api/v1/users, /api/v1/users.
• 🎨 Design Tokens System: Stylesheets are controlled globally via variables (--font-sans, --font-mono, --font-pixel, --bg-yellow, --color-black, etc.).

🚦 Dynamic Endpoint Routing

| Route / Endpoint | Type | Method | File Location | | :--- | :--- | :--- | :--- | | /api/v1/health | Backend API | GET | index.html:317 | | /api/v1/health | Backend API | GET | index.html:317 | | /api/v1/users | Backend API | POST | index.html:321 | | /api/v1/users | Backend API | POST | index.html:321 |

🎨 CSS Style Custom Variables

| Variable Name | Assigned Value | Source File | | :--- | :--- | :--- | | --font-sans | 'Share Tech Mono', 'Courier New', Courier, monospace | styles.css:7 | | --font-mono | 'Share Tech Mono', 'Courier New', Courier, monospace | styles.css:8 | | --font-pixel | 'VT323', monospace | styles.css:9 | | --bg-yellow | #ffec00 | styles.css:12 | | --color-black | #000000 | styles.css:13 | | --color-white | #ffffff | styles.css:14 | | --color-text-primary | #000000 | styles.css:16 | | --color-text-secondary | #222222 | styles.css:17 | | --color-text-dim | #444444 | styles.css:18 | | --accent-cyan | #00ffff | styles.css:21 | | --accent-pink | #ff00ff | styles.css:22 | | --accent-green | #39ff14 | styles.css:23 | | --accent-purple | #9d4edd | styles.css:24 | | --border-thick | 3px solid #000000 | styles.css:27 | | --border-thin | 2px solid #000000 | styles.css:28 | | --shadow-brutal | 4px 4px 0px #000000 | styles.css:29 | | --shadow-brutal-large | 8px 8px 0px #000000 | styles.css:30 | | --shadow-brutal-small | 2px 2px 0px #000000 | styles.css:31 | | --transition-fast | all 0.15s cubic-bezier(0.175, 0.885, 0.32, 1.275) | styles.css:33 | | --container-max-width | 1200px | styles.css:34 | | --bg-yellow | #ffffff | styles.css:1559 | | --color-white | #ffffff | styles.css:1560 | | --color-black | #000000 | styles.css:1561 |

📦 Dependencies & Manifest Breakdown

📄 package.json (Node/JS/TS)

Project/Module Name: @sujoymoulick/scanner-skill

No active dependencies declared in this manifest.

🏗️ Codebase Directory Tree

├── 📂 templates/
│   ├── 📄 instruction.template.md (1.3 KB)
│   └── 📄 ui.template.md (577 B)
├── 📄 .gitignore (171 B)
├── 📄 index.html (52.9 KB)
├── 📄 package.json (1 KB)
├── 📄 README.md (10.2 KB)
├── 📄 scan.js (67.2 KB)
└── 📄 styles.css (35.3 KB)

📊 Repository Metrics & Statistics

Language & Extension Breakdown

| File Extension | File Count | Combined Size | Total Lines | | :--- | :--- | :--- | :--- | | .md (Markdown) | 3 | 12.1 KB | 310 | | `` () | 1 | 171 B | N/A | | .html (HTML) | 1 | 52.9 KB | 937 | | .json (JSON) | 1 | 1 KB | 46 | | .js (JavaScript) | 1 | 67.2 KB | 1849 | | .css (CSS) | 1 | 35.3 KB | 1677 |

🔝 Top 5 Largest Files

| File Path | Size | File Type | | :--- | :--- | :--- | | scan.js | 67.2 KB | JavaScript | | index.html | 52.9 KB | HTML | | styles.css | 35.3 KB | CSS | | README.md | 10.2 KB | Markdown | | templates/instruction.template.md | 1.3 KB | Markdown |

🚀 Step-by-Step Development Roadmap

Follow these steps to safely initialize, develop, and extend this project:

Phase 1: Environment Setup

1. Clone / Checkout: Ensure all workspace files are available locally.
2. Node Environment: Verify Node.js (v16+) is loaded. Install dependencies:

   npm install

3. Environment Variables: Create a .env file in the root if the project requires credentials or API urls.

Phase 2: Codebase Extension & Development Instructions

When expanding codebase capabilities, respect the following design guidelines:

A. How to Add New Routes / Endpoints

1. Locate the main router definition files shown in the routing map table.
2. Declare the new route endpoint using consistent method signatures:
   • Backend APIs: Follow REST standards, returning formatted JSON blocks.
3. Register the handler or element inside the routing configuration.

B. Working with Styling & Theme Custom Variables

1. Do NOT write duplicate hardcoded hex color values or fonts.
2. Use the registered variables at the top of sheets via: color: var(--color-variable-name);.
3. If modifying themes, change variables inside the global :root selector.

C. Managing Ecosystem Dependencies

1. Always register new packages in the primary manifest files (e.g. package.json, requirements.txt).
2. Do NOT perform manual direct script loading unless absolutely necessary.

Phase 3: Testing & Code Verification

1. Local Dev Server: Boot the application locally to test additions.

   npm run dev

2. Linting & Style Checks: Run code checks to avoid runtime regressions.
3. Unit Tests: Build custom unit testing scripts (e.g., Jest, PyTest, go test) in a dedicated tests/ folder.

⚙️ How to Setup & Run (Original Instructions)

No dedicated install instructions detected in the original project readme.

🤖 AI Agent Coding Guidelines (Context Guard)

[!IMPORTANT] When delegating tasks to AI agents, instruct them strictly as follows:

1. Preserve Architecture: Do not modify routing schemes or file structure layouts without consulting this file tree.
2. Maintain CSS Variables: Always reuse discovered style variable tokens to preserve theme alignment.
3. Zero Duplication: Ensure functions are reusable and placed inside appropriate utility classes.
4. No Placeholders: Never write incomplete placeholder code blocks.

💡 Vibe Coding & AI Agent Token Optimization

[!TIP] Token Saver Advantage: AI agents (like Cursor, Gemini, Tabnine, and Copilot) have limited context window allocations and API limits. Running this scanner compiles your repository into lightweight blueprints. Directing your AI agent to read only this directory provides 100% architectural and routing context while saving up to 90%+ of tokens!

🚀 Step-by-Step Vibe Coding Walkthrough:

1. Navigate to your target repository:

   cd <target-folder-name>

2. Execute the static sweep via npx:

   npx @sujoymoulick/scanner-skill

   (Alternatively, if installed globally, simply run scanner-skill)
3. Feed the Blueprints to your AI Agent: Direct your assistant to read the compiled files under scanner_skill/ to code with absolute architectural clarity at a fraction of the token cost!

👤 About the Developer

This Codebase Scanner Skill Engine was designed and engineered by Sujoy Moulick.

• Role: AI/ML & Frontend Architect (B.Tech CSE AI/ML student at UEM Jaipur)
• Philosophy: "Bridging the gap between complex software engineering and intuitive user experiences; viewing coding as an interactive art form."
• Portfolio & Projects: sujoymoulick.online (Adhyayan, Meghdoot, Textora)
• Contact: [email protected]

Generated with ❤️ by Sujoy Moulick & Pramaaan Unified Codebase Blueprint Engine.