CodeSpot AI - Retro Code Review CLI

🚀 AI-powered code review with authentic 80s retro style!

A command-line interface that brings the nostalgia of 80s computing to modern code review. CodeSpot AI analyzes your code using artificial intelligence while delivering results in a pixel-perfect retro interface.

Features ✨

• 🎮 Retro 80s Interface - Authentic pixel-art styling and CRT-era aesthetics
• 🤖 AI-Powered Analysis - Advanced code review using OpenAI GPT models
• 🔒 CLI-Only Authentication - No browser required, pure terminal experience
• 📊 Multi-Language Support - JavaScript, TypeScript, Python, Java, and more
• ⚡ Multiple Review Types - Full, quick, security, and performance reviews
• 🎯 Smart Code Detection - Automatically finds and analyzes code files
• 📈 Detailed Reports - Scores, issues, suggestions, and summaries
• 💾 Export Options - Save reviews in JSON, Markdown, or text formats

Installation 🚀

npm install -g codespot-ai

Quick Start 🏃‍♂️

1. Initialize CodeSpot AI in your project:

codespot init

2. Configure your OpenAI API key:

codespot config api-key

3. Login to your account:

codespot login

4. Start reviewing code:

# Review a single file
codespot review src/main.js

# Review entire project
codespot review .

# Review with retro effects
codespot review . --retro

Commands 📋

codespot init

Initialize CodeSpot AI in your project directory.

codespot init [--force]

codespot login

Login to CodeSpot AI (CLI-only, no browser required).

codespot login [-u username] [-p password]

codespot review <path>

Review code files or directories.

codespot review <file-or-directory> [options]

Options:
  -t, --type <type>      Review type: full, quick, security, performance
  -o, --output <format>  Output format: console, json, markdown
  --save                 Save review to file
  --retro                Enable retro mode effects

codespot config <setting>

Configure CodeSpot AI settings.

codespot config <setting> [options]

Settings:
  api-key    Configure OpenAI API key
  model      Select AI model (gpt-4, gpt-3.5-turbo, etc.)
  theme      Choose UI theme (retro, modern, matrix, cyberpunk)

Review Types 🔍

• Full Review (--type full) - Comprehensive analysis of code quality
• Quick Review (--type quick) - Fast analysis focusing on major issues
• Security Review (--type security) - Focus on security vulnerabilities
• Performance Review (--type performance) - Performance optimization suggestions

Themes 🎨

Choose your visual experience:

• Retro (default) - Authentic 80s computing aesthetic
• Modern - Clean, minimal interface
• Matrix - Hacker-style green terminal
• Cyberpunk - Neon-drenched futuristic look

Configuration ⚙️

CodeSpot AI creates a .codespot.json configuration file in your project:

{
  "name": "my-project",
  "version": "1.0.0",
  "ai": {
    "model": "gpt-4",
    "max_tokens": 2000,
    "temperature": 0.1
  },
  "review": {
    "include_patterns": ["**/*.js", "**/*.ts", "**/*.jsx", "**/*.tsx", "**/*.py"],
    "exclude_patterns": ["node_modules/**", "dist/**", "build/**"],
    "max_file_size": "1MB"
  }
}

Examples 💡

Review a TypeScript file

codespot review src/components/Button.tsx --type security --save

Quick review of entire project

codespot review . --type quick --output json

Performance review with retro effects

codespot review src/ --type performance --retro

Export review as Markdown

codespot review main.py --output markdown --save

Supported Languages 💻

• JavaScript (.js, .jsx, .mjs)
• TypeScript (.ts, .tsx)
• Python (.py)
• Java (.java)
• C# (.cs)
• C/C++ (.c, .cpp, .cc, .cxx)
• Go (.go)
• Rust (.rs)
• PHP (.php)
• Ruby (.rb)
• Swift (.swift)
• Kotlin (.kt)
• HTML/CSS
• JSON, XML, YAML
• Markdown

Retro Experience 🕹️

Enable retro mode for the full 80s experience:

codespot review . --retro

Features include:

• Pixel-art ASCII banners
• Retro color schemes
• CRT-style loading animations
• 8-bit inspired progress bars
• Authentic terminal aesthetics

API Key Setup 🔑

CodeSpot AI requires an OpenAI API key:

1. Get your API key from OpenAI Platform
2. Configure it using: codespot config api-key
3. Your key is stored securely in your home directory

Global Configuration 📁

Configuration is stored in ~/.codespot/config.json:

{
  "version": "1.0.0",
  "auth": {
    "logged_in": true,
    "user": "your-username"
  },
  "ai": {
    "provider": "openai",
    "model": "gpt-4"
  },
  "ui": {
    "theme": "retro",
    "colors": true,
    "animations": true
  }
}

Troubleshooting 🔧

"API key not configured"

Run codespot config api-key to set up your OpenAI API key.

"Please login first"

Run codespot login to authenticate with CodeSpot AI.

"No code files found"

Ensure you're in a directory with supported code files, or check your include/exclude patterns.

Large files being skipped

Adjust max_file_size in .codespot.json or use --force flag.

Requirements 📋

• Node.js 14.0.0 or higher
• OpenAI API key
• Terminal with color support (recommended)

Contributing 🤝

We welcome contributions! Please see our Contributing Guide for details.

License 📄

MIT License - see LICENSE file for details.

Support 💬

• 📧 Email: [email protected]
• 🐛 Issues: GitHub Issues
• 📖 Documentation: Wiki

Made with ❤️ and retro vibes from the 80s

CodeSpot AI - Because debugging should feel like playing an arcade game 🕹️