Getting Started

Ready to yeet your code? Follow these steps to get started with the ultimate Git companion.

Quick Install

Install yeet-git globally using npm or yarn:

npm install -g yeet-git

pnpm add -g yeet-git

yarn global add yeet-git

bun add --global yeet-git

Initialization

Once installed, navigate to any Git repository and run the setup wizard:

yeet init

The wizard will guide you through:

1. 📦 GH_CLI_VERIFY: Checking if GitHub CLI is installed.
2. 🔐 AUTH_ORCHESTRATOR: Logging into your GitHub account.
3. 🔑 AI_CORE_LINK: Setting up your Gemini API key for smart commits.

Global Configuration

You can manage your configuration at any time by editing the global config file or using the CLI:

yeet config --list

[!TIP] Make sure your GEMINI_API_KEY is set for the best experience. The AI logic depends on this for generating high-quality commit messages.