GitIQ

GitIQ is an AI-powered pair programming tool that leverages Git as the primary interface, enabling seamless collaboration without the need for embedding in an IDE. With GitIQ, developers can describe changes in natural language and receive complete code modifications, enhancing productivity and simplifying the development workflow.

Background

View our Hackathon Presentation for a complete overview of GitIQ and its innovative approach to AI pair programming.

Submitted to the Berkeley RDI LLM Agents Hackathon - December 2024

Table of Contents

• Features
• Quick Start
• Installation
• Configuration
  • Git Configuration
  • LLM API Configuration
  • Model Configuration
  • GitHub Integration
• Usage
• Documentation
• Contributing

Features

• Git Integration: Uses Git as the primary interface, allowing for seamless integration into existing workflows.
• AI-Powered Code Changes: Transforms natural language descriptions into code modifications in a local branch or a GitHub Pull Request.
• Flexible PR Titles: Generates descriptive PR titles that are not restricted by branch naming conventions.
• Context Preservation: Maintains a clear history of AI-human collaboration through Git commits.
• Multi-File Support: Handles changes across multiple files as coherent units of work.
• Reviewable Changes: Generates changes that can be reviewed and merged, fitting into standard code review processes.
• Flexible Configuration: Supports multiple LLM providers and models through easy-to-edit configuration files.
• IDE Agnostic: Works with any editor or IDE since changes flow through Git.
• Change Type Selection: Choose between creating changes in a local branch or pushing to GitHub as a Pull Request.

Quick Start

To get started with GitIQ, follow these steps:

Prerequisites

• Python 3.7 or higher: Ensure Python is installed on your system.
• Git: Git must be installed and configured.
• OpenAI API Key: An API key for OpenAI or other supported LLM providers.
• GitHub Access Token: Required if you want to enable GitHub integration.

Installation

Clone the repository:

git clone https://github.com/yourusername/gitiq.git
cd gitiq

Install the required Python packages:

pip install -r requirements.txt

Running the Application

Set your API key and run the application:

export OPENAI_API_KEY=your_api_key_here
python agent/app.py

Alternatively, you can run the application with the API key inline:

OPENAI_API_KEY=your_api_key_here python agent/app.py

Configuration

GitIQ uses a config.json file for various settings. Below is an overview of the configuration options.

Git Configuration

"git": {
  "name": "GitIQ Bot",
  "email": "[email protected]"
}

Set the Git user name and email for commits made by GitIQ.

LLM API Configuration

"llm_apis": {
  "openai": {
    "api_base": "https://api.openai.com/v1",
    "api_key": "OPENAI_API_KEY"
  },
  "lmproxy": {
    "api_base": "https://api.lmproxy.org/v1",
    "api_key": "OPENAI_API_KEY"
  }
}

Define the LLM API endpoints and their corresponding API keys. API keys are specified as environment variable names.

Model Configuration

"models": {
  "Claude 3.5 Sonnet": {
    "llm_api": "claude",
    "name": "claude-3-5-sonnet-20240620",
    "nojson": true
  },
  "OpenAI o1-preview (via OpenRouter)": {
    "llm_api": "openrouter",
    "name": "openai/o1-preview"
  }
}

Define the available models, specifying which API to use, the model name, and any special flags like nojson for models that don't support JSON output.

GitHub Integration

To enable GitHub integration, update the config.json file:

"github": {
  "enabled": true,
  "access_token": "GITHUB_ACCESS_TOKEN",
  "repo_owner": "your_github_username",
  "repo_name": "your_repository_name"
}

• enabled: Set to true to enable GitHub integration.
• access_token: Your GitHub access token, stored as an environment variable.
• repo_owner: The owner of the repository.
• repo_name: The name of the repository.

Note: When GitHub integration is enabled, GitIQ can push new branches to the remote repository (origin) to create Pull Requests if the Change Type is set to GitHub PR. Ensure that:

• You have the necessary permissions to push to the remote repository.
• Your local repository is correctly connected to the remote via origin.
• The remote repository URL is set appropriately in your local Git configuration.

Usage

Once the application is running, you can start using GitIQ to assist with your coding tasks. Describe the changes you want to make in natural language, select the Change Type (either Local Branch or GitHub PR), and GitIQ will generate the corresponding code changes. If you choose Local Branch, the changes will be committed to a new local branch. If you choose GitHub PR, GitIQ will push the branch to GitHub and create a Pull Request with a descriptive title for your review.

Documentation

For more detailed information, please refer to the following documents:

• User Guide: Comprehensive guide for using GitIQ
• Product Requirements Document: Detailed requirements and specifications
• API Specification: Information about the API endpoints and usage
• Style Guide: Guidelines for contributing to the project
• Hackathon Presentation: Slides from the Berkeley RDI LLM Agents Hackathon

Contributing

We welcome contributions! Please read our Style Guide before contributing to ensure consistency in the codebase. You can contribute by submitting Pull Requests, reporting issues, or suggesting new features.