🚀 VERTEX CLI

AI-Powered Developer Productivity Tools

macOS • Linux • Windows (WSL)

Installation • Features • Usage • How It Works

✨ Features

🤖 AI Commits

Generate perfect conventional commit messages using local AI. No cloud APIs - 100% private.

vertex-commit

🔍 Diagnostics

TypeScript, ESLint & npm audit with AI-powered error explanations.

vertex-check

📦 Version Bump

Interactive semantic versioning with auto-commit support.

vertex-bump

📥 Installation

npm install -g vertex-cli

That's it! 🎉 All dependencies are auto-installed.

🎯 Usage

AI-Powered Commits

# Stage your changes
git add .

# Generate AI commit message
vertex-commit

  ██╗   ██╗███████╗██████╗ ████████╗███████╗██╗  ██╗
  ██║   ██║██╔════╝██╔══██╗╚══██╔══╝██╔════╝╚██╗██╔╝
  ██║   ██║█████╗  ██████╔╝   ██║   █████╗   ╚███╔╝ 
  ╚██╗ ██╔╝██╔══╝  ██╔══██╗   ██║   ██╔══╝   ██╔██╗ 
   ╚████╔╝ ███████╗██║  ██║   ██║   ███████╗██╔╝ ██╗
    ╚═══╝  ╚══════╝╚═╝  ╚═╝   ╚═╝   ╚══════╝╚═╝  ╚═╝

  ✓ Changes Detected: 3 files
  ✓ AI Generated: feat(auth): add OAuth2 login flow
  
  Accept? [Y/n]

Project Diagnostics

vertex-check

Runs comprehensive checks:

• ✅ TypeScript compilation
• ✅ ESLint analysis
• ✅ npm audit security scan
• ✅ Dead code detection
• 🤖 AI error explanations

Version Management

vertex-bump

• 📌 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

| OS | Package Manager | |:---|:----------------| | 🍎 macOS | Homebrew | | 🐧 Ubuntu/Debian | apt | | 🎩 Fedora/RHEL | dnf | | 🏔️ Alpine | apk | | 🔵 Arch | pacman | | 🪟 Windows | WSL + apt/brew |

🔒 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):

# 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

import { defineConfig } from "vite";
import packageJson from "./package.json";

export default defineConfig({
  define: {
    __APP_VERSION__: JSON.stringify(packageJson.version),
  },
});

2. Add Type Definition (src/vite-env.d.ts)

declare const __APP_VERSION__: string;

3. Use in Component

<span>v{__APP_VERSION__}</span>

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

Made with 💜 for developers who value their time

⬆ Back to Top