Add Git branch name generation feature with AI support

Author: recrsn

.github/workflows/release.yml

@@ -30,4 +30,4 @@ jobs:
           version: latest
           args: release --clean
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/test.yml

@@ -27,4 +27,4 @@ jobs:
         run: go vet ./...
 
       - name: Run tests
-        run: go test -race -coverprofile=coverage.txt -covermode=atomic ./...
+        run: go test -race -coverprofile=coverage.txt -covermode=atomic ./...

.goreleaser.yml

@@ -32,4 +32,4 @@ changelog:
     exclude:
       - '^docs:'
       - '^test:'
-      - '^ci:'
+      - '^ci:'

README.md

@@ -10,6 +10,12 @@ Git AI enhances your Git workflow with AI-powered features.
   - Commit automatically with `--auto` flag
   - Add detailed descriptions with `--with-descriptions`
   - Control format with `--conventional` and `--no-conventional` flags
+- `git ai branch`: Generates meaningful branch names from user input
+  - Create descriptive branch names based on your description
+  - Check existing local and remote branches for naming conventions
+  - Provide interactive approval with edit option
+  - Create branch automatically with `--auto` flag
+  - Print branch name only without creating with the option menu
 - `git ai config`: Manages LLM settings
   - Set up API keys for your preferred provider
   - Offer various models (OpenAI, Anthropic, Ollama, etc.)
@@ -122,6 +128,15 @@ git ai commit --no-conventional
 # Amend previous commit
 git ai commit --amend
 
+# Generate branch name
+git ai branch "Add sorting feature to user list"
+
+# Generate branch with auto-approval
+git ai branch --auto "Fix authentication bug"
+
+# Provide description with flag
+git ai branch -d "Update documentation for API endpoints"
+
 # Use specific config file
 git ai --config /path/to/config.yaml commit
 ```
@@ -166,9 +181,14 @@ Git AI embeds prompt templates from text files into the binary at compile time.
 
 - `commit_system.txt`: LLM instructions with sections for conventional vs. standard format
 - `commit_user.txt`: User prompt template with placeholders for content
-
-Both files use Go's template syntax:
-- `{{if .UseConventional}}...{{else}}...{{end}}` controls format instructions
-- `{{.Diff}}`, `{{.ChangedFiles}}`, `{{.RecentCommits}}` insert content
+- `branch_system.txt`: LLM instructions for branch name generation
+- `branch_user.txt`: User prompt template for branch creation
+
+The prompt files use Go's template syntax:
+- For commit prompts:
+  - `{{if .UseConventional}}...{{else}}...{{end}}` controls format instructions
+  - `{{.Diff}}`, `{{.ChangedFiles}}`, `{{.RecentCommits}}` insert content
+- For branch prompts:
+  - `{{.Request}}`, `{{.LocalBranches}}`, `{{.RemoteBranches}}` insert content
 
 Rebuild with `go build` after modifying prompts.

cmd/branch/branch.go

@@ -0,0 +1,122 @@
+package branch
+
+import (
+	"os"
+
+	"github.com/recrsn/git-ai/pkg/config"
+	"github.com/recrsn/git-ai/pkg/git"
+	"github.com/recrsn/git-ai/pkg/llm"
+	"github.com/recrsn/git-ai/pkg/logger"
+	"github.com/recrsn/git-ai/pkg/ui"
+	"github.com/spf13/cobra"
+)
+
+var (
+	autoApprove bool
+	description string
+)
+
+// Cmd represents the branch command
+var Cmd = &cobra.Command{
+	Use:   "branch [description]",
+	Short: "Generate a meaningful Git branch name",
+	Long:  `Analyzes your input and existing branches to generate a meaningful branch name.`,
+	Args:  cobra.MaximumNArgs(1),
+	Run: func(cmd *cobra.Command, args []string) {
+		// If description is provided as an argument, use it
+		if len(args) > 0 {
+			description = args[0]
+		}
+
+		// If no description is provided, prompt for one
+		if description == "" {
+			var err error
+			description, err = ui.PromptForInput("Enter a brief description of your branch:", "")
+			if err != nil {
+				logger.Fatal("Error prompting for description: %v", err)
+			}
+			if description == "" {
+				logger.Error("Description cannot be empty.")
+				os.Exit(1)
+			}
+		}
+
+		executeBranch(description)
+	},
+}
+
+func init() {
+	Cmd.Flags().BoolVar(&autoApprove, "auto", false, "Automatically approve the generated branch name without prompting")
+	Cmd.Flags().StringVarP(&description, "description", "d", "", "Brief description of the branch purpose")
+}
+
+func executeBranch(description string) {
+	cfg, err := config.LoadConfig()
+	if err != nil {
+		logger.Fatal("Failed to load config: %v", err)
+	}
+
+	// Generate branch name - with spinner
+	spinner, err := ui.ShowSpinner("Generating branch name with LLM...")
+	if err != nil {
+		logger.Error("Failed to start spinner: %v", err)
+	}
+
+	branchName, err := llm.GenerateBranchName(cfg, description)
+	if err != nil {
+		if spinner != nil {
+			spinner.Fail("Failed to generate branch name!")
+		}
+		logger.Fatal("Failed to generate branch name: %v", err)
+	}
+
+	if spinner != nil {
+		spinner.Success("Branch name generated!")
+	}
+
+	// If auto-approve flag is not set, ask user to confirm or edit
+	var proceed bool
+	if !autoApprove {
+		ui.DisplayBox("Generated Branch Name", branchName)
+
+		options := []string{"Create branch", "Edit name", "Print name only", "Cancel"}
+		selectedOption, err := ui.PromptForSelection(options, "Create branch", "What would you like to do?")
+		if err != nil {
+			logger.Fatal("Error prompting for selection: %v", err)
+		}
+
+		switch selectedOption {
+		case "Create branch":
+			proceed = true
+		case "Edit name":
+			// Use text input for editing with pre-filled value
+			branchName, err = ui.PromptForInput("Edit branch name:", branchName)
+			if err != nil {
+				logger.Fatal("Error prompting for input: %v", err)
+			}
+			if branchName == "" {
+				logger.Error("Branch name cannot be empty.")
+				os.Exit(1)
+			}
+			proceed = true
+		case "Print name only":
+			logger.PrintMessage(branchName)
+			os.Exit(0)
+		case "Cancel":
+			logger.PrintMessage("Branch creation cancelled.")
+			os.Exit(0)
+		}
+	} else {
+		proceed = true
+	}
+
+	if proceed {
+		// Create the branch
+		err = git.CreateBranch(branchName)
+		if err != nil {
+			logger.Fatal("Failed to create branch: %v", err)
+		}
+
+		logger.PrintMessagef("Branch '%s' created successfully!", branchName)
+	}
+}

install.sh

@@ -58,15 +58,15 @@ else
     fi
   else
     print_step "No local binary found, downloading from GitHub releases..."
-    
+
     # Get latest release from GitHub API
     LATEST_RELEASE_URL=$(curl -s https://api.github.com/repos/recrsn/git-ai/releases/latest | grep "browser_download_url.*$(uname -s | tr '[:upper:]' '[:lower:]')*$(uname -m)*" | cut -d : -f 2,3 | tr -d \")
-    
+
     if [ -z "$LATEST_RELEASE_URL" ]; then
       print_error "Could not find a release for your platform ($(uname -s), $(uname -m))"
       exit 1
     fi
-    
+
     print_step "Downloading from: $LATEST_RELEASE_URL"
     curl -L -o "$INSTALL_DIR/$BINARY_NAME" "$LATEST_RELEASE_URL"
     chmod +x "$INSTALL_DIR/$BINARY_NAME"
@@ -80,7 +80,7 @@ chmod +x "$INSTALL_DIR/$BINARY_NAME"
 # Check if ~/.local/bin is in PATH
 if [[ ":$PATH:" != *":$INSTALL_DIR:"* ]]; then
   print_warning "$INSTALL_DIR is not in your PATH"
-  
+
   # Determine shell and provide appropriate command
   SHELL_NAME="$(basename "$SHELL")"
   case "$SHELL_NAME" in
@@ -106,4 +106,4 @@ else
 fi
 
 print_success "Installation complete!"
-print_step "Run 'git ai config' to set up your LLM provider"
+print_step "Run 'git ai config' to set up your LLM provider"

main.go

@@ -1,6 +1,7 @@
 package main
 
 import (
+	"github.com/recrsn/git-ai/cmd/branch"
 	"github.com/recrsn/git-ai/cmd/commit"
 	cmdConfig "github.com/recrsn/git-ai/cmd/config"
 	"github.com/recrsn/git-ai/pkg/config"
@@ -39,6 +40,7 @@ func init() {
 	rootCmd.PersistentFlags().StringVar(&configPath, "config", "", "Path to config file (default is $HOME/.git-ai.yaml and ./.git-ai.yaml)")
 
 	// Add subcommands
+	rootCmd.AddCommand(branch.Cmd)
 	rootCmd.AddCommand(commit.Cmd)
 	rootCmd.AddCommand(cmdConfig.Cmd)
 }

pkg/git/git.go

@@ -5,7 +5,6 @@ import (
 	"fmt"
 	"os"
 	"os/exec"
-	"path/filepath"
 	"regexp"
 	"strings"
 
@@ -223,3 +222,58 @@ func SetConfig(key, value string) error {
 	}
 	return nil
 }
+
+// GetLocalBranches returns a list of local git branches
+func GetLocalBranches() ([]string, error) {
+	cmd := exec.Command("git", "branch", "--format=%(refname:short)")
+	var out bytes.Buffer
+	cmd.Stdout = &out
+	err := cmd.Run()
+	if err != nil {
+		logger.Error("Error getting local branches: %v", err)
+		return nil, fmt.Errorf("error getting local branches: %v", err)
+	}
+
+	branches := strings.Split(strings.TrimSpace(out.String()), "\n")
+	var result []string
+	for _, branch := range branches {
+		if branch != "" {
+			result = append(result, branch)
+		}
+	}
+	return result, nil
+}
+
+// GetRemoteBranches returns a list of remote git branches
+func GetRemoteBranches() ([]string, error) {
+	cmd := exec.Command("git", "branch", "-r", "--format=%(refname:short)")
+	var out bytes.Buffer
+	cmd.Stdout = &out
+	err := cmd.Run()
+	if err != nil {
+		logger.Error("Error getting remote branches: %v", err)
+		return nil, fmt.Errorf("error getting remote branches: %v", err)
+	}
+
+	branches := strings.Split(strings.TrimSpace(out.String()), "\n")
+	var result []string
+	for _, branch := range branches {
+		if branch != "" {
+			result = append(result, branch)
+		}
+	}
+	return result, nil
+}
+
+// CreateBranch creates a new git branch
+func CreateBranch(name string) error {
+	cmd := exec.Command("git", "checkout", "-b", name)
+	var stderr bytes.Buffer
+	cmd.Stderr = &stderr
+	err := cmd.Run()
+	if err != nil {
+		logger.Error("Error creating branch %s: %v: %s", name, err, stderr.String())
+		return fmt.Errorf("error creating branch %s: %v: %s", name, err, stderr.String())
+	}
+	return nil
+}

pkg/llm/llm.go

@@ -93,3 +93,84 @@ func generateSimpleMessage() string {
 
 	return message
 }
+
+// GenerateBranchName generates a branch name based on user input and existing branches
+func GenerateBranchName(cfg config.Config, request string) (string, error) {
+	if cfg.Endpoint == "" || cfg.APIKey == "" {
+		return "", fmt.Errorf("LLM endpoint or API key not configured")
+	}
+
+	client, err := NewClient(cfg.Endpoint, cfg.APIKey)
+	if err != nil {
+		return "", fmt.Errorf("failed to create LLM client: %w", err)
+	}
+
+	// Get lists of existing branches
+	localBranches, err := git.GetLocalBranches()
+	if err != nil {
+		logger.Warn("Failed to get local branches: %v", err)
+		localBranches = []string{}
+	}
+
+	remoteBranches, err := git.GetRemoteBranches()
+	if err != nil {
+		logger.Warn("Failed to get remote branches: %v", err)
+		remoteBranches = []string{}
+	}
+
+	// Get system and user prompts
+	systemPrompt := GetBranchSystemPrompt()
+	userPrompt, err := GetBranchUserPrompt(request, localBranches, remoteBranches)
+	if err != nil {
+		return "", fmt.Errorf("failed to build prompt: %w", err)
+	}
+
+	// Call the LLM API
+	messages := []Message{
+		{
+			Role:    "system",
+			Content: systemPrompt,
+		},
+		{
+			Role:    "user",
+			Content: userPrompt,
+		},
+	}
+
+	response, err := client.ChatCompletion(cfg.Model, messages)
+	if err != nil {
+		return "", fmt.Errorf("failed to get completion: %w", err)
+	}
+
+	// Clean up the response
+	branchName := strings.TrimSpace(response)
+
+	// Ensure it doesn't contain any invalid characters
+	branchName = sanitizeBranchName(branchName)
+
+	return branchName, nil
+}
+
+// sanitizeBranchName ensures the branch name follows Git conventions
+func sanitizeBranchName(name string) string {
+	// Replace spaces with hyphens
+	name = strings.ReplaceAll(name, " ", "-")
+
+	// Remove any Git-unfriendly characters
+	name = strings.Map(func(r rune) rune {
+		if (r >= 'a' && r <= 'z') || (r >= 'A' && r <= 'Z') || (r >= '0' && r <= '9') || r == '-' || r == '/' || r == '_' || r == '.' {
+			return r
+		}
+		return '-'
+	}, name)
+
+	// Convert multiple hyphens to a single one
+	for strings.Contains(name, "--") {
+		name = strings.ReplaceAll(name, "--", "-")
+	}
+
+	// Trim hyphens from the start and end
+	name = strings.Trim(name, "-")
+
+	return name
+}