Skip to content
This repository was archived by the owner on Mar 16, 2025. It is now read-only.
/ roastme Public archive

A witty CLI tool that analyzes your shell history and brutally roasts your command-line habits using AI to keep your ego in check.

License

Notifications You must be signed in to change notification settings

JasonLovesDoggo/roastme

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GoRoastMe

Get roasted by AI for your terminal habits

img.png Go Reference Go Report Card License: MIT

📖 Overview

GoRoastMe is a fun CLI tool that analyzes your command history and generates humorous "roasts" based on your terminal habits.

Whether you're making the same typos, using excessively complex commands, or spending too much time on social media sites through the terminal, RoastMe will call you out with style.

✨ Features

  • 🔍 Analyzes your shell command history (supports Bash, Zsh, and Fish)
  • 🤖 Generates personalized roasts using AI (Google Gemini, OpenAI, or Anthropic)
  • 🏠 Works locally without API keys or internet connection
  • 🎨 Beautiful TUI using Bubble Tea and Lip Gloss
  • 🧩 Extensible with custom AI providers

🚀 Installation

Using Go

go install github.com/jasonlovesdoggo/roastme@latest

Pre-built binaries

Download the latest release for your platform.

💻 Usage

Basic Usage

Simply run:

roastme

This will analyze your recent command history and generate a humorous roast using the local (non-AI) engine.

Advanced Usage

# Get a deeper analysis of your command history
roastme --deep

# Configure your AI provider settings
roastme config

⚙️ Configuration

RoastMe supports multiple AI providers, with Google Gemini set as the default. You can configure your preferred provider in two ways:

1. Interactive Configuration

Run the configuration UI:

roastme config

This will open an interactive terminal UI where you can:

  • Select your preferred AI provider (local, Google Gemini, OpenAI, Anthropic, or custom)
  • Enter your API credentials
  • Set model preferences

2. Manual Configuration

Edit ~/.roastme.toml:

[ai]
provider = "gemini" # Options: local, gemini, openai, anthropic, custom

[ai.openai]
api_key = "your-openai-api-key"
base_url = "https://api.openai.com/v1"
model = "gpt-3.5-turbo"

[ai.gemini]
api_key = "your-gemini-api-key"
base_url = "https://generativelanguage.googleapis.com"
model = "gemini-pro"

[ai.anthropic]
api_key = "your-anthropic-api-key"
base_url = "https://api.anthropic.com"
model = "claude-2"

[ai.custom]
api_key = "your-custom-api-key"
base_url = "https://api.your-provider.com"
model = "your-model"

[ui]
colorTheme = "dark" # Options: dark, light
style = "rounded"   # Options: rounded, double, thick

🔎 What RoastMe Analyzes

RoastMe looks for patterns in your command history, including:

  • Repeated commands - Are you running the same command over and over?
  • Failed commands - Typos and error patterns
  • Complex commands - Extremely long one-liners or pipe chains
  • Indecision - Excessive use of cd, ls, and other navigation commands
  • Time wasters - Commands that access time-wasting websites
  • Skill level - Command complexity to determine your terminal proficiency

🤝 Contributing

Contributions are welcome! Here's how you can contribute:

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

📝 License

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

🙏 Acknowledgments

Made with ❤️ and a sense of humor

About

A witty CLI tool that analyzes your shell history and brutally roasts your command-line habits using AI to keep your ego in check.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Languages