system-compat-checker 1.0.2

A cross-platform CLI tool for checking system compatibility with AI-powered analysis

System Compatibility Checker

A powerful cross-platform CLI tool for checking system compatibility with various applications. This tool collects detailed system information and uses AI-powered analysis to determine if your system meets the requirements for specific software.

✨ Features

• 🖥️ Cross-platform support - Works on Windows, Linux, and macOS
• 📊 Comprehensive system analysis - CPU, memory, storage, GPU, and performance metrics
• 🤖 AI-powered compatibility analysis - Uses Groq API for intelligent assessments
• 🎨 Rich terminal interface - Beautiful, colorized output with tables and panels
• 🔒 Secure credential management - Safe API key storage using system keyring
• 📄 Multiple output formats - Console tables, JSON, and file output
• ⚡ Fast performance - Quick system information collection

🚀 Quick Start

Installation

pip install system-compat-checker

Verify Installation

# Check if installation is working
python -m system_compat_checker install-check

# If syscheck command works:
syscheck --help

# If not, use module syntax (always works):
python -m system_compat_checker --help

Setup (First Time)

# Get a free API key at console.groq.com first

# Method 1: Direct command (if syscheck works)
syscheck setup YOUR_API_KEY

# Method 2: Module syntax (always works)
python -m system_compat_checker setup YOUR_API_KEY

Check Your System

# View system information
syscheck system-info

# Check compatibility with an application
syscheck check "Adobe Photoshop"

📖 Usage

Commands

Command	Description	Example
syscheck version	Show version information	syscheck version
syscheck setup	Configure Groq API key	syscheck setup --force
syscheck system-info	Display system information	syscheck system-info --json
syscheck check	Check application compatibility	syscheck check "Blender" -r req.json
syscheck reset	Remove stored API key	syscheck reset

System Information

# Formatted table output
syscheck system-info

# JSON output for scripting
syscheck system-info --json > my_system.json

Compatibility Analysis

# Basic compatibility check
syscheck check "Visual Studio Code"

# With custom requirements file
syscheck check "My Game" --requirements game_requirements.json

# Save results to file
syscheck check "Photoshop" --output compatibility_report.json

Requirements File Format

Create custom application requirements using JSON:

{
  "application": "My Application",
  "requirements": {
    "cpu": {
      "cores": 4,
      "frequency": 2.5
    },
    "memory": {
      "ram": 8
    },
    "storage": {
      "free": 10
    },
    "gpu": {
      "required": true,
      "memory": 4
    }
  }
}

🛠️ Development

From Source

# Clone the repository
git clone https://github.com/yourusername/system-compat-checker.git
cd system-compat-checker

# Create virtual environment
python -m venv .venv
source .venv/bin/activate  # Windows: .venv\Scripts\activate

# Install in development mode
pip install -e .

# Run tests
pytest

Project Structure

system-compat-checker/
├── src/                    # Source code
│   ├── cli.py             # CLI interface
│   ├── system_info.py     # System information collection
│   ├── groq_analyzer.py   # AI compatibility analysis
│   ├── storage.py         # Secure API key storage
│   ├── windows_info.py    # Windows-specific collectors
│   └── posix_info.py      # Linux/macOS collectors
├── tests/                 # Unit tests
├── docs/                  # Documentation
└── examples/              # Example files

📚 Documentation

• User Guide - Comprehensive usage documentation
• Project Documentation - Technical architecture details
• Contributing Guide - Development guidelines

🔧 System Requirements

• Python 3.8 or higher
• Internet connection (for AI analysis)
• Groq API key (free at console.groq.com)

🤝 Contributing

We welcome contributions! Please see our Contributing Guide for details on:

• Code style and standards
• Testing requirements
• Pull request process
• Development setup

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🆘 Support

• Documentation: Check the User Guide for detailed instructions
• Issues: Report bugs on GitHub Issues
• Discussions: Join conversations in GitHub Discussions

🏆 Acknowledgments

• Built with Click for CLI interface
• Powered by Groq for AI analysis
• Uses Rich for beautiful terminal output
• System information via psutil

---

Made with ❤️ by the System Compatibility Checker Team