README.md

🧠 noidea

Git assistant with AI commit messages and sassy feedback

🗿 What is noidea?

noidea is a Git companion that makes your commits better and funnier:

• Get smart commit messages based on your changes
• Receive sassy feedback from a judgmental Moai after each commit
• Analyze your Git history for insights and patterns
• Seamless integration with Git workflows

✨ Key Features

• 🧠 AI-Powered Suggestions - Get professional commit messages based on your staged changes
• 🗿 Moai Feedback - Receive witty, personalized feedback on your commits
• 📊 Git Insights - Track coding patterns and get weekly summaries
• 🎭 Multiple Personalities - Choose from several AI personalities for feedback
• 🔒 Secure API Key Management - Keep your AI provider keys safe
• 🚀 GitHub Integration - Manage GitHub releases with AI-enhanced release notes and smart workflow awareness

🚀 Quick Start

# Install noidea
git clone https://github.com/AccursedGalaxy/noidea
cd noidea
./install.sh # (might require sudo)

# Set up in your Git repo
cd /path/to/your/repo
noidea init

# Enable auto commit suggestions (optional)
git config noidea.suggest true

# Add your API key for AI features
noidea config apikey

# Set up GitHub integration (optional)
noidea github auth
noidea github hook-install

📝 Commit Workflow With noidea

# Stage your changes
git add .

# Commit (noidea will suggest a message)
git commit

This will open your default editor with the suggested commit message. Save and close to approve and commit.

🤖 AI Configuration

For AI-powered features, add your API key:

1. Securely store your API key (recommended):

   noidea config apikey

2. Add to environment (alternative):

   export XAI_API_KEY=your_api_key_here

3. Configure interactively:

   noidea config --init

See API Key Management for secure storage details.

🚀 GitHub Integration

noidea provides seamless GitHub integration for managing releases and generating release notes:

1. Set up GitHub integration:

   # Authenticate with GitHub
   noidea github auth
   
   # Install GitHub hooks (optional)
   noidea github hook-install

2. Generate enhanced release notes:

   # Generate release notes for the latest tag
   noidea github release notes
   
   # Wait for GitHub workflows to complete before generating notes
   noidea github release notes --wait-for-workflows
   
   # Generate notes for a specific tag
   noidea github release notes --tag=v1.2.3

3. Automatic version management with the version script:

   # Bump patch version (0.0.x)
   ./scripts/version.sh patch
   
   # Bump minor version (0.x.0)
   ./scripts/version.sh minor

The release notes generator enhances GitHub's standard release notes with AI-powered descriptions while preserving GitHub's changelog with commit links.

📋 Available Commands

Command	Description
noidea init	Set up Git hooks in your repository
noidea suggest	Get commit message suggestions
noidea moai	Display Moai feedback for the last commit
noidea summary [--days 30]	Generate summary of recent Git activity
noidea feedback [--count 5]	Analyze specific commits
noidea config --init	Configure noidea interactively
noidea moai --list-personalities	List all available personalities
noidea github auth	Authenticate with GitHub using a PAT
noidea github status	Check GitHub authentication status
noidea github hook-install	Install GitHub integration hooks
noidea github release notes	Generate AI-enhanced release notes
noidea github release notes --wait-for-workflows	Wait for GitHub Actions to complete before generating notes

Run noidea --help for more information.

🎭 AI Personalities

noidea has several AI personalities for feedback:

• Snarky Code Reviewer - Witty, sarcastic feedback
• Supportive Mentor - Encouraging, positive feedback
• Git Expert - Technical, professional feedback
• Motivational Speaker - Energetic enthusiasm

# Use a specific personality
noidea moai --personality supportive_mentor

easily setup your own personality or edit existing ones!

⚙️ Advanced Configuration

Create a ~/.noidea/config.json file:

{
  "llm": {
    "enabled": true,
    "provider": "xai",
    "api_key": "",
    "model": "grok-2-1212",
    "temperature": 0.7
  },
  "moai": {
    "use_lint": false,
    "faces_mode": "random",
    "personality": "snarky_reviewer",
    "personality_file": "~/.noidea/personalities.toml"
  }
}

🛠️ Feature Status

Feature	Status
Moai face after commit	✅ Done
AI-based commit feedback	✅ Done
Config file support	✅ Done
Weekly summaries	✅ Done
On-demand commit analysis	✅ Done
Commit message suggestions	✅ Done
Enhanced terminal output	✅ Done
POSIX-compatible hooks	✅ Done
AI Release notes	✅ Done
AI GitHub issue management	🔜 Coming Soon

🤝 Contributing

Contributions are welcome! Whether you have ideas for new features, have encountered bugs, or want to improve documentation, we'd love your input.

Please feel free to submit an issue or join the discussions. Each contribution helps us make noidea better.

🤯 Why noidea?

Because Git is too serious. Coding is chaos. Let's embrace it.

This tool won't improve your Git hygiene, but it will make it more entertaining.

📃 License

This project is distributed under the MIT License. See the LICENSE file for details.

---

Made with noidea and late-night energy.