larats 1.0.2 → 1.1.1

package/README.md

@@ -1,7 +1,7 @@
 # LaraTS ⚡
 
 > **Smart Architecture Visualizer & Contextual Module Scaffolder CLI**  
-> Tailor-made for **Laravel** & **TypeScript** (Node.js / Express / React / Monorepo) projects.
+> Tailor-made for **Laravel**, **TypeScript**, and **JavaScript (Node.js)** projects.
 
 [![npm version](https://img.shields.io/npm/v/larats.svg)](https://www.npmjs.com/package/larats)
 [![CI](https://github.com/SidiqFatuh187/Larats/actions/workflows/ci.yml/badge.svg)](https://github.com/SidiqFatuh187/Larats/actions/workflows/ci.yml)
@@ -18,8 +18,8 @@ When codebases grow large, developers often struggle to understand the architect
 
 1. 🔍 **Architecture Scanner & Visualizer (`scan`)**: Instantly scans your repository, categorizes layers (Models, Controllers, Services, Actions, Filament Resources, Routes, etc.), and generates a clean `ARCHITECTURE.md` with an interactive **Mermaid.js flowchart** and directory tree.
 2. 🏗️ **Contextual Module Scaffolder (`scaffold` / `make`)**: Quickly generates cohesive feature modules with clean, production-ready boilerplate code tailored to your exact stack (Laravel or TypeScript).
-3. 🔒 **100% Local & Secure**: No data ever leaves your computer. Sensitive files (`.env`, private keys, vendor folders) are strictly excluded.
-
+3. 🤖 **AI Architecture Context Packager (`ai`)**: Exports a token-efficient system prompt teaching Cursor AI, Claude, Copilot, or ChatGPT your exact layered boundaries (`--copy`, `--cursor`, `--claude`).
+4. 🔒 **100% Local & Secure**: No data ever leaves your computer. Sensitive files (`.env`, private keys, vendor folders) are strictly excluded.
 ---
 
 ## 🚀 Quick Start
@@ -30,9 +30,15 @@ Run instantly without installation via `npx`:
 # Interactive menu mode
 npx larats
 
-# Or scan architecture directly
+# Scan architecture & display terminal pipeline
 npx larats scan
 
+# Open interactive Mermaid diagram in your browser
+npx larats view
+
+# Export architecture context rules for AI (Cursor, Claude, Copilot)
+npx larats ai --copy
+
 # Or scaffold a new module directly
 npx larats scaffold Payment
 ```
@@ -44,6 +50,38 @@ npm install -g larats
 larats
 ```
 
+
+---
+
+## 👀 How to View Your Project Architecture
+
+LaraTS makes your codebase architecture visible in 4 convenient ways:
+
+1. 🌐 **Interactive Local Browser (`larats view` / `larats scan --view`)**:
+   Spawns a local browser tab displaying the interactive Mermaid flowchart, component counts, and directory tree.
+   ```bash
+   npx larats view
+   # or scan and open viewer immediately
+   npx larats scan --view
+   ```
+
+2. 📟 **Terminal Architecture Pipeline**:
+   Every time you run `larats scan`, LaraTS prints an ASCII pipeline of your request lifecycle directly in the terminal:
+   ```text
+   Client ──> Routes [4] ──> Controllers [4] ──> Services [2] ──> Models [6] ──> Database
+   ```
+
+3. 🐙 **GitHub & GitLab Native Preview**:
+   Commit and push `ARCHITECTURE.md` to your repository. GitHub natively renders Mermaid.js flowcharts into interactive graphics directly on the web page.
+
+4. 💻 **VS Code & Cursor**:
+   Open `ARCHITECTURE.md` and press `Ctrl+Shift+V` (`Cmd+Shift+V` on macOS) to open the built-in Markdown Preview.
+
+5. 📄 **Standalone HTML Export (`--html`)**:
+   Generate a self-contained `ARCHITECTURE.html` file that can be opened in any web browser without any server:
+   ```bash
+   npx larats scan --html
+   ```
 ---
 
 ## ✨ Key Features
@@ -83,6 +121,13 @@ Create new features in seconds with consistent boilerplate:
 ### 3. 🛡️ Anti-Overwrite Protection
 LaraTS will **NEVER** silently overwrite your existing code. If a target file already exists, LaraTS skips it and alerts you. You can only overwrite files by explicitly providing `--force`.
 
+
+### 4. 🤖 AI Architecture Context Packager (`ai`)
+Teach AI coding assistants (Cursor, Claude Code, GitHub Copilot, ChatGPT) your exact project architecture rules so they never write misplaced code again:
+- **Copy to Clipboard**: `larats ai --copy` — Copies clean, compressed architecture instructions (< 500 tokens) ready to paste into ChatGPT or Claude.
+- **Cursor AI Rules**: `larats ai --cursor` — Injects architecture boundaries and directory maps directly into `.cursorrules`.
+- **Claude Code Rules**: `larats ai --claude` — Injects architecture conventions into `CLAUDE.md`.
+*(Safe merge: uses `<!-- larats-rules:start -->` tags so existing user instructions are never overwritten).*
 ---
 
 ## 🔒 Strict Security & Safety Guarantees
@@ -106,19 +151,26 @@ USAGE:
 
 COMMANDS:
   scan                 Scan repository & generate ARCHITECTURE.md
+  view, preview        Open interactive architecture diagram in local browser
+  ai                   Export architecture context prompt for AI (Cursor, Claude, Copilot)
   scaffold, make [name] Scaffold a new module or feature with clean boilerplate
   info                 Show detected project type & architectural flavor
   help                 Display help message
 
 OPTIONS:
-  -o, --output <file>    Output markdown path for scan (default: ARCHITECTURE.md)
+  -o, --output <file>    Output path for scan (default: ARCHITECTURE.md)
+  --view                 Open local browser viewer immediately after scanning
+  --copy                 Copy AI architecture context prompt to clipboard
+  --cursor               Inject architecture rules into .cursorrules
+  --claude               Inject architecture rules into CLAUDE.md
+  -t, --tree             Print directory tree in terminal
+  --html                 Also export standalone ARCHITECTURE.html
   -m, --modular          Enforce modular directory structure
   -s, --standard         Enforce standard/layered directory structure
   --dry-run              Simulate generation without writing files
   -f, --force            Overwrite files if they already exist
   -v, --version          Display CLI version
   -h, --help             Display help message
-```
 
 ### Examples