CodeGPT: Instructions file for Claude Code

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Project Overview

CodeGPT is a CLI tool written in Go that generates git commit messages and code reviews using AI. It supports multiple AI providers (OpenAI, Azure OpenAI, Gemini, Anthropic, Ollama, Groq, OpenRouter) and integrates with git prepare-commit-msg hooks.

Build and Development Commands

# Build the binary
make build              # outputs to bin/codegpt

# Install globally
make install

# Run all tests with coverage
make test               # or: go test -v -cover -coverprofile coverage.txt ./...

# Run a single test
go test -v -run TestName ./path/to/package

# Format go files (auto-installs golangci-lint if missing)
make fmt

# Lint (auto-installs golangci-lint v2 if missing)
make lint

Development Guidelines

IMPORTANT: When making changes to this codebase, you MUST:

1. Write Tests - Always write corresponding tests for any new functionality or bug fixes
2. Pass Linting - All code must pass make lint validation before submission
3. Format Code - Always run make fmt to ensure consistent coding style

Architecture

Core Design Pattern

CodeGPT uses a provider pattern where all AI services implement the core.Generative interface:

type Generative interface {
    Completion(ctx context.Context, content string) (*Response, error)
    GetSummaryPrefix(ctx context.Context, content string) (*Response, error)
}

This allows adding new AI providers without changing core logic.

Package Structure

• cmd/ - CLI commands using Cobra

  • cmd.go - Root command setup with Viper config initialization (supports env vars with CI platform prefixes like GITHUB_ and DRONE_)
  • commit.go - Generate commit messages (codegpt commit)
  • review.go - Generate code reviews (codegpt review)
  • hook.go - Git hook management (codegpt hook install/uninstall)
  • provider.go - Factory functions for instantiating AI providers (NewOpenAI, NewGemini, NewAnthropic)
  • config.go, config_set.go, config_list.go - Configuration management