Let's F______| Go!

Getting Started

Get up and running with LEt's F______ Go! in minutes. Follow this guide to install dependencies, configure your environment, and start automating your Git workflow.

⚡ Quick Start

Already have the prerequisites? Get started in 30 seconds: 

# Install Community Edition (Free)
curl -fsSL https://lfg.foo/install.sh | bash

# Or install Pro Edition with license key
LFG_LICENSE_KEY=LFG-XXXX-XXXX-XXXX curl -fsSL https://lfg.foo/install.sh | bash

# Initialize in your project
cd your-project
lfg --init

# Start using it!
lfg --pr  # AI commit + push + create PR

System Requirements

⚠️ Required Dependencies

zsh
Zsh Shell
LEt's F______ Go! is built for Zsh and requires it to run
git
Git
Version control system (obviously!)
jq
jq
JSON processor for configuration and API responses
curl
curl
HTTP client for API calls
python3
Python 3
For YAML processing and configuration management
sed
sed
Stream editor for text processing
awk
awk
Text processing tool

✨ Recommended (Optional)

gh
GitHub CLI
For automatic PR creation and GitHub integration
Install Guide →
fzf
fzf
Fuzzy finder for interactive reviewer selection
Install Guide →
claude
Claude CLI
For Claude AI integration via CLI
Install Guide →
openai
OpenAI CLI
For OpenAI integration via CLI
Install Guide →

Installation

🍎 macOS Installation

1. Install dependencies with Homebrew:

# Install required dependencies
brew install jq curl python3

# Install optional but recommended tools
brew install gh fzf

# Zsh is pre-installed on macOS 10.15+

2. Install LEt's F______ Go!:

# Community Edition (Free)
curl -fsSL https://lfg.foo/install.sh | bash

# Pro Edition (with license key)
LFG_LICENSE_KEY=LFG-XXXX-XXXX-XXXX curl -fsSL https://lfg.foo/install.sh | bash

🐧 Linux Installation

Ubuntu/Debian:

# Install required dependencies
sudo apt update
sudo apt install zsh jq curl python3 python3-pip sed gawk

# Install GitHub CLI (optional)
curl -fsSL https://cli.github.com/packages/githubcli-archive-keyring.gpg | sudo dd of=/usr/share/keyrings/githubcli-archive-keyring.gpg
echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/githubcli-archive-keyring.gpg] https://cli.github.com/packages stable main" | sudo tee /etc/apt/sources.list.d/github-cli.list > /dev/null
sudo apt update
sudo apt install gh

CentOS/RHEL/Fedora:

# Install required dependencies
sudo dnf install zsh jq curl python3 python3-pip sed gawk

# Or for older versions:
# sudo yum install zsh jq curl python3 python3-pip sed gawk

Configuration

🚀 Initial Setup

1. Initialize in your project:

cd your-project
lfg --init

This creates a .lfg/ directory with configuration files.

2. Choose your AI provider:

During initialization, you'll be prompted to select:

  • • claude - Anthropic's Claude (recommended)
  • • openai - OpenAI's GPT models
  • • gemini - Google's Gemini
  • • system - Use system prompts (no AI)

3. Set your preferred method:

  • • cli - Use provider's CLI tool
  • • api - Direct API calls (requires API keys)
  • • system - No AI, manual prompts

🔑 API Keys Setup

If using API method, set up your API keys in .lfg/.env:

# For Claude API
ANTHROPIC_API_KEY=your_claude_api_key_here

# For OpenAI API
OPENAI_API_KEY=your_openai_api_key_here

# For Gemini API
GOOGLE_API_KEY=your_gemini_api_key_here

Security Note: The .lfg/ directory should be added to your .gitignore to keep API keys secure.

🐙 GitHub Integration

1. Install and authenticate GitHub CLI:

gh auth login

2. Enable PR creation:

GitHub integration is enabled by default. Use --pr flag to create pull requests automatically.

Basic Usage

⚡ Common Commands

lfg

Auto-generate commit message from staged changes

lfg --offline

Use offline mode (no AI)

lfg --pr

Create a pull request after commit

lfg --dry-run

Preview what would happen without making changes

🔧 Advanced Options

lfg --model gpt-4

Set specific AI model

lfg --assign me --review "user1,user2"

Set PR assignees and reviewers

lfg --labels "bug,urgent"

Add labels to PR

lfg --base develop

Set target branch for PR

Troubleshooting

❌ "Missing required deps" error

Make sure all required dependencies are installed:

which jq curl python3 sed awk

❌ "Not a git repo" error

LEt's F______ Go! must be run inside a Git repository:

git init

❌ API key errors

Check your API keys in .lfg/.env and ensure they're valid. You can test with:

lfg --skip-validate

❌ GitHub CLI issues

Ensure GitHub CLI is authenticated:

gh auth status

🎉 You're Ready!

You've successfully set up LEt's F______ Go!! Now you can streamline your Git workflow with AI-powered commit messages and automated PR creation.

📚 Read Full Documentation 💬 Get Support