Skip to content

README.md

Latest commit

 

History

History
304 lines (214 loc) · 8.03 KB

README.md

File metadata and controls

304 lines (214 loc) · 8.03 KB

🪦 Graveyard

AI-Powered Process Monitor & Security Scanner

Monitor, Analyze, and Secure Your System Processes with Intelligence

Go Version License Platform Release

Features • Installation • Quick Start • Documentation • Contributing

Graveyard Demo Real-time process monitoring with AI-powered analysis

✨ Features

🎯 Core Features

  • 📊 Real-time Monitoring - Live CPU & Memory tracking
  • 🔄 Auto-refresh - Updates every second
  • 🎨 Beautiful UI - Clean terminal interface with progress bars
  • ⚡ Fast & Lightweight - Minimal resource usage
  • 🖥️ Cross-platform - Windows, Linux, macOS, ARM

🤖 AI-Powered

  • 🧠 Smart Analysis - Google Gemini AI integration
  • 🛡️ Malware Detection - VirusTotal scanning
  • 🔍 Combined Intelligence - AI + VirusTotal analysis
  • 💡 Process Insights - Understand what's running
  • 🔒 Security Scoring - Risk assessment

🚀 Installation

Quick Install

Linux / macOS:

curl -fsSL https://raw.githubusercontent.com/rexreus/Graveyard/main/setup/install.sh | bash

Windows (PowerShell):

irm https://raw.githubusercontent.com/REXREUS/Graveyard/main/setup/install.ps1 | iex

Manual Download

Download the latest binary for your platform:

Platform Architecture Download
🪟 Windows x64 graveyard.exe
🐧 Linux x64 graveyard
🐧 Linux ARM64 graveyard-arm
🍎 macOS Intel graveyard-darwin
🍎 macOS Apple Silicon graveyard-darwin-arm

Build from Source

# Clone the repository
git clone https://github.com/REXREUS/Graveyard.git
cd Graveyard

# Install dependencies
go mod download

# Build
./setup/build.sh    # Linux/Mac
setup\build.bat     # Windows

⚡ Quick Start

1. Run Graveyard

graveyard

2. Configure API Keys (Optional)

Press s in the app to open Settings, or create .env file:

cp .env.example .env

Get your free API keys:

Add to .env:

GEMINI_API_KEY=your_api_key_here
VIRUSTOTAL_API_KEY=your_virustotal_api_key_here

3. Start Monitoring!

Key Action Description
↑ ↓ Navigate Move through process list
i 🤖 AI Inspect Analyze process with Gemini AI
t 🛡️ Threat Scan Check with VirusTotal + AI
k ⚠️ Kill Process Terminate selected process
s ⚙️ Settings Configure API keys
q / Esc 🚪 Quit Exit application

📸 Screenshots

Main Interface

Main Interface

AI Analysis

AI Analysis

VirusTotal Scan

VirusTotal Scan

🎯 Use Cases

  • 🔍 System Monitoring - Track resource usage in real-time
  • 🛡️ Security Auditing - Scan suspicious processes
  • 🐛 Debugging - Identify resource-hungry applications
  • 📊 Performance Analysis - Optimize system performance
  • 🔒 Malware Detection - Check for threats with VirusTotal

💡 Why Graveyard?

Traditional Tools 🪦 Graveyard
Basic process list ✨ AI-powered insights
Manual analysis 🤖 Automated intelligence
No security checks 🛡️ Built-in malware scanning
Complex interfaces 🎨 Clean, intuitive UI
Platform-specific 🌍 Cross-platform

🔧 System Requirements

  • Runtime: No dependencies needed (standalone binary)
  • Build: Go 1.21+ (only for building from source)
  • Terminal: Unicode support recommended
  • Network: Internet connection for AI features

🆘 Troubleshooting

Permission Denied when Killing Process

Some processes require elevated privileges:

  • Windows: Run as Administrator
  • Linux/macOS: sudo graveyard
AI Features Not Working
  1. Press s to check API key configuration
  2. Verify internet connection
  3. Check logs: graveyard.log
  4. Ensure API keys are valid
Binary Not Found After Install
  • Windows: Restart terminal to refresh PATH
  • Linux/macOS: Check /usr/local/bin is in PATH

📚 Documentation

🚀 Getting Started

🎨 Features

🛠️ Development

🔒 Security

Graveyard takes security seriously:

  • 🔐 API keys stored securely in .env (permissions: 0600)
  • 🚫 .env automatically excluded from git
  • 🔄 Supports key rotation
  • 📊 No data collection or telemetry

Security Best Practices:

# Never commit secrets
echo ".env" >> .gitignore

# Set proper permissions
chmod 600 .env

# Rotate keys regularly
# Monitor usage in provider dashboards

See SECURITY.md for detailed information.

🗑️ Uninstall

Linux / macOS:

 curl -fsSL https://raw.githubusercontent.com/REXREUS/Graveyard/main/setup/uninstall.sh |bash

Windows:

irm https://raw.githubusercontent.com/REXREUS/Graveyard/main/setup/uninstall.ps1 | iex

🤝 Contributing

We love contributions! Here's how you can help:

  1. 🍴 Fork the repository
  2. 🌿 Create a feature branch (git checkout -b feature/amazing)
  3. 💾 Commit your changes (git commit -m 'Add amazing feature')
  4. 📤 Push to the branch (git push origin feature/amazing)
  5. 🎉 Open a Pull Request

See CONTRIBUTING.md for detailed guidelines.

📝 License

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

🌟 Star History

If you find Graveyard useful, please consider giving it a star! ⭐

Star History

Star History Chart

💬 Support

Made with ❤️ by REXREUS

⬆ Back to Top