git-ai-tool v1.0.7

git-ai-tool

A CLI tool to automate git commit and push using a React Terminal interface.

Features

• 🤖 AI-Powered Commit Messages: Generates semantic commit messages using OpenAI
• 🖥️ Interactive UI: Beautiful terminal interface built with React Ink
• 🔍 Smart Change Detection: Automatically detects staged and unstaged changes
• 🔄 Streamlined Workflow: Guides you through the commit and push process
• 🔗 PR Integration: Provides pull request URLs after pushing
• 📊 Operation Summary: Shows a summary of all actions taken

Installation

# Install globally
npm install -g git-ai-tool

# Set required environment variables
export OPENAI_API_KEY="your-openai-api-key"
export GITHUB_TOKEN="your-github-token" # Optional, for PR detection

Usage

Navigate to any Git repository and run:

git-ai-tool commit

The interactive terminal UI will guide you through:

1. Reviewing staged and unstaged changes
2. Staging changes if needed
3. Generating and confirming a commit message
4. Pushing changes to remote
5. Providing a PR URL if applicable

Requirements

• Node.js 16.0.0 or higher
• Git installed and configured
• OpenAI API key for commit message generation
• GitHub token (optional) for PR detection

Environment Variables

You can set these in your shell profile or use a tool like direnv to manage them per project.

Development

Clone the repository and install dependencies:

git clone https://github.com/yourusername/git-ai-tool.git
cd git-ai-tool
npm install

Run in development mode:

npm run dev

Build the project:

npm run build

How It Works

1. Repository Check: Verifies you're in a valid Git repository
2. Change Detection: Identifies staged and unstaged changes
3. AI Generation: Uses OpenAI to create a semantic commit message
4. Commit Process: Commits changes with the generated message
5. Push Handling: Pushes to remote and checks for PR opportunities
6. Summary: Provides a summary of all actions taken

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

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

• Ink - React for CLIs
• OpenAI - AI-powered commit message generation
• Commander.js - Command-line interface

Made with ❤️ by Sam