vertex-cli 1.0.2 → 1.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Lakshya Rohila
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,38 +1,197 @@
-# VERTEX CLI
+<div align="center">
 
-## Installation
+![VERTEX CLI Banner](https://raw.githubusercontent.com/lakshyarohila/vertex-cli/main/assets/banner.png)
+
+# 🚀 VERTEX CLI
+
+**AI-Powered Developer Productivity Tools**
+
+[![npm version](https://img.shields.io/npm/v/vertex-cli?color=a855f7&style=for-the-badge)](https://www.npmjs.com/package/vertex-cli)
+[![npm downloads](https://img.shields.io/npm/dm/vertex-cli?color=00ffff&style=for-the-badge)](https://www.npmjs.com/package/vertex-cli)
+[![License](https://img.shields.io/badge/license-MIT-green?style=for-the-badge)](LICENSE)
+
+**macOS** • **Linux** • **Windows (WSL)**
+
+[Installation](#-installation) • [Features](#-features) • [Usage](#-usage) • [How It Works](#-how-it-works)
+
+</div>
+
+---
+
+## ✨ Features
+
+<table>
+<tr>
+<td align="center" width="33%">
+
+### 🤖 AI Commits
+Generate perfect conventional commit messages using local AI. No cloud APIs - 100% private.
+
+```bash
+vertex-commit
+```
+
+</td>
+<td align="center" width="33%">
+
+### 🔍 Diagnostics
+TypeScript, ESLint & npm audit with AI-powered error explanations.
+
+```bash
+vertex-check
+```
+
+</td>
+<td align="center" width="33%">
+
+### 📦 Version Bump
+Interactive semantic versioning with auto-commit support.
+
+```bash
+vertex-bump
+```
+
+</td>
+</tr>
+</table>
+
+---
+
+## 📥 Installation
 
 ```bash
 npm install -g vertex-cli
 ```
 
-## Usage
+**That's it!** 🎉 All dependencies are auto-installed.
+
+---
+
+## 🎯 Usage
+
+### AI-Powered Commits
 
-### Smart Commit
 ```bash
+# Stage your changes
+git add .
+
+# Generate AI commit message
 vertex-commit
 ```
 
-### System Diagnostics
+<details>
+<summary>📸 See Example Output</summary>
+
+```
+  ██╗   ██╗███████╗██████╗ ████████╗███████╗██╗  ██╗
+  ██║   ██║██╔════╝██╔══██╗╚══██╔══╝██╔════╝╚██╗██╔╝
+  ██║   ██║█████╗  ██████╔╝   ██║   █████╗   ╚███╔╝ 
+  ╚██╗ ██╔╝██╔══╝  ██╔══██╗   ██║   ██╔══╝   ██╔██╗ 
+   ╚████╔╝ ███████╗██║  ██║   ██║   ███████╗██╔╝ ██╗
+    ╚═══╝  ╚══════╝╚═╝  ╚═╝   ╚═╝   ╚══════╝╚═╝  ╚═╝
+
+  ✓ Changes Detected: 3 files
+  ✓ AI Generated: feat(auth): add OAuth2 login flow
+  
+  Accept? [Y/n]
+```
+
+</details>
+
+### Project Diagnostics
+
 ```bash
 vertex-check
 ```
 
-### Version Bump
+Runs comprehensive checks:
+- ✅ TypeScript compilation
+- ✅ ESLint analysis
+- ✅ npm audit security scan
+- ✅ Dead code detection
+- 🤖 AI error explanations
+
+### Version Management
+
 ```bash
 vertex-bump
 ```
 
-## Security
-This package contains compiled binaries to ensure integrity and protection of the core logic.
+- 📌 Patch (0.0.x) - Bug fixes
+- 🔧 Minor (0.x.0) - New features
+- 🚀 Major (x.0.0) - Breaking changes
+
+---
+
+## 🔧 How It Works
+
+### Zero-Setup Experience
+
+When you run any VERTEX command, it automatically:
+
+```
+1️⃣  Detects your OS (macOS / Linux / Windows WSL)
+    ↓
+2️⃣  Installs missing dependencies
+    • gum (terminal UI)
+    • jq (JSON processing)
+    • Ollama (local AI engine)
+    ↓
+3️⃣  Downloads AI model (qwen2.5-coder:1.5b)
+    ↓
+4️⃣  Starts Ollama server
+    ↓
+5️⃣  Runs your command! ✨
+```
+
+### Supported Package Managers
 
-## 🔗 Integration Guide: Version Sync
+| OS | Package Manager |
+|:---|:----------------|
+| 🍎 macOS | Homebrew |
+| 🐧 Ubuntu/Debian | apt |
+| 🎩 Fedora/RHEL | dnf |
+| 🏔️ Alpine | apk |
+| 🔵 Arch | pacman |
+| 🪟 Windows | WSL + apt/brew |
 
-Want to display the version in your web app (like `v1.2.3`)?
+---
 
-### 1. Update `vite.config.ts`
-Expose the version from `package.json` to your app:
+## 🔒 Privacy First
+
+- **100% Local AI** - Uses Ollama, runs on your machine
+- **No Cloud APIs** - Your code never leaves your computer
+- **No Data Collection** - Zero telemetry
+
+---
+
+## 💻 System Requirements
+
+| Requirement | Minimum |
+|:------------|:--------|
+| Node.js | 16+ |
+| RAM | 4GB (8GB recommended for AI) |
+| Disk | 2GB free space |
+
+### Windows Users
+
+VERTEX requires **WSL** (Windows Subsystem for Linux):
+
+```powershell
+# Install WSL (run as Administrator)
+wsl --install
+
+# Then install vertex-cli inside WSL
+npm install -g vertex-cli
+```
 
+---
+
+## 🔗 Integration Guide
+
+### Display Version in Your App
+
+**1. Update `vite.config.ts`**
 ```typescript
 import { defineConfig } from "vite";
 import packageJson from "./package.json";
@@ -41,29 +200,49 @@ export default defineConfig({
   define: {
     __APP_VERSION__: JSON.stringify(packageJson.version),
   },
-  // ... rest of config
 });
 ```
 
-### 2. Add Type Definition
-Create `src/vite-env.d.ts` so TypeScript knows about the constant:
-
+**2. Add Type Definition** (`src/vite-env.d.ts`)
 ```typescript
-/// <reference types="vite/client" />
 declare const __APP_VERSION__: string;
 ```
 
-### 3. Use in React Component
-Now you can use `__APP_VERSION__` anywhere!
-
+**3. Use in Component**
 ```tsx
-export function VersionFooter() {
-  return (
-    <div className="text-gray-500 text-sm">
-      v{__APP_VERSION__}
-    </div>
-  );
-}
+<span>v{__APP_VERSION__}</span>
 ```
 
-Now run `vertex-bump`, and your UI will update automatically! 🚀
+Now run `vertex-bump` and your UI updates automatically! 🎉
+
+---
+
+## 📋 Commands Reference
+
+| Command | Description |
+|:--------|:------------|
+| `vertex-commit` | AI-powered commit message generator |
+| `vertex-check` | Project diagnostics & health check |
+| `vertex-bump` | Interactive version bumping |
+
+---
+
+## 🤝 Contributing
+
+Contributions welcome! Please open an issue first to discuss changes.
+
+---
+
+## 📄 License
+
+MIT © [VERTEX](https://github.com/lakshyarohila)
+
+---
+
+<div align="center">
+
+**Made with 💜 for developers who value their time**
+
+[⬆ Back to Top](#-vertex-cli)
+
+</div>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vertex-cli",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "description": "Protected CLI for VERTEX Diagnostics & Commit Intelligence",
   "bin": {
     "vertex-commit": "bin/vertex-commit",
@@ -20,5 +20,5 @@
     "diagnostics"
   ],
   "author": "VERTEX",
-  "license": "UNLICENSED"
+  "license": "MIT"
 }