Gity CLI

AI-powered commit message generator for teams.

Installation

Install globally via npm:

npm install -g gityai

Or using pnpm:

pnpm install -g gityai

Quick Start

1. Login

   gity login
   # Opens browser for secure authentication

2. Initialize in your repository

   cd your-project
   gity init
   # Select team and ruleset

3. Generate commit messages

   git add .
   gity generate
   # AI generates commit message from your changes

Commands

Core Commands

• gity init - Initialize .gity.yaml with team and ruleset
• gity generate - Generate commit message from staged changes
  • Use -l or --local to bypass authentication and use local rules only.
• gity preview - Preview commit message examples
• gity status - Show current configuration and user info
• gity --help - Show all available commands

Authentication

• gity login - Login via secure browser magic link
• gity logout - Logout and clear credentials
• gity whoami - Show current user

Teams

• gity team list - List your teams
• gity team show <slug> - Show team details
• gity team switch <slug> - Switch active team

Rulesets & Rules

• gity rules list - List all available rulesets
• gity rules show - Show current ruleset from .gity.yaml
• gity presets - List available preset templates

Members & Invites

• gity members list - List team members
• gity invite generate - Generate invite link (admin only)
• gity invite join <code> - Join team with invite code

Stash Management

• gity stash - Interactive menu to commit or manage stashed messages
• gity stash list - List stashed commit messages
• gity stash save <message> - Save a commit message to stash

Configuration

• gity config set <key> <value> - Set configuration value
• gity config get <key> - Get configuration value
• gity config list - List all configuration

Configuration

Global Config

Location: ~/.gity-config.json

Contains:

• API URL
• Authentication token
• Active team
• User information

Local Config

Location: .gity.yaml (per repository)

Contains:

• Team slug
• Ruleset configuration
• Local rules (optional)
• Created timestamp

Development

For contributors:

# Clone the repository
git clone https://github.com/CtrlAltDelete-Ops/Gity-xt.git
cd Gity-xt/cli

# Install dependencies
pnpm install

# Build
pnpm build

# Link for local testing
pnpm link --global

# Run in development mode
pnpm dev

# Type check
pnpm typecheck

Features

• 🤖 AI-Powered: Generates meaningful commit messages from your changes
• 👥 Team-Based: Share rulesets and conventions across your team
• 📝 Customizable: Define custom rules and patterns
• 🔒 Secure: Browser-based authentication with magic links
• 💾 Stash: Save and reuse commit messages
• 🌐 Local-First: Works entirely offline and without authentication for repository-level operations and local generation

Requirements

• Node.js >= 18.0.0
• Git repository
• Gity account (create at gity.app)

License

MIT