Getting Started with noidea

Welcome to noidea, the Git assistant that adds a fun twist to your workflow! This guide will help you get up and running quickly.

Introduction

noidea is a Git companion that provides AI-powered commit message suggestions and entertaining feedback after each commit, making your Git experience more enjoyable and productive.

Prerequisites

Before you begin, make sure you have:

• Git installed and configured
• Go 1.23+ (if building from source)
• An API key from one of the supported AI providers (for AI features)

Quick Setup

Here's how to get started in just a few minutes:

# Install noidea
git clone https://github.com/AccursedGalaxy/noidea
cd noidea
./install.sh

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

# Configure your API key
noidea config apikey

Next Steps

After setting up noidea, check out these guides:

• Installation Options - Detailed installation instructions
• Configuration - Customize noidea's behavior
• Command Overview - Learn about available commands

Quick Demo

Here's a quick example of noidea in action:

1. Stage your changes with git add .
2. Run git commit (noidea will suggest a message)
3. After committing, enjoy feedback from the Moai

Getting Help

If you encounter any issues, check out the Troubleshooting section or open an issue on GitHub.