repobird-cli

module
v0.1.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 19, 2025 License: AGPL-3.0

README ΒΆ

RepoBird CLI

Go Version CI Status Release

RepoBird CLI is a powerful command-line interface and terminal UI for RepoBird.ai - the AI-powered code generation platform. Submit coding tasks to AI agents, track progress in real-time, and manage your development workflows efficiently from your terminal.

🎯 What is RepoBird?

RepoBird is an AI platform that automates code generation and software development tasks. Simply describe what you want to build or fix, and RepoBird's AI agents will create pull requests with the changes. The CLI tool gives you full control over this process directly from your terminal.

Key Features
  • πŸ€– AI-Powered Development: Submit tasks in natural language and get production-ready code
  • πŸ“Š Real-Time Monitoring: Track AI agent progress with live updates
  • 🎨 Interactive Dashboard: Rich terminal UI with intuitive navigation
  • πŸ”„ Batch Operations: Submit and manage multiple tasks simultaneously
  • πŸ” Smart Search: Fuzzy search across repositories and runs
  • πŸ›‘οΈ Duplicate Prevention: Automatic detection prevents accidental re-submissions
  • πŸ” Secure Authentication: Safe API key management with multiple auth methods

πŸ“¦ Installation

macOS
Direct Download
# Download latest release for macOS (Apple Silicon)
curl -L https://github.com/RepoBird/repobird-cli/releases/latest/download/repobird_darwin_arm64.tar.gz | tar xz
sudo mv repobird /usr/local/bin/

# For Intel Macs
curl -L https://github.com/RepoBird/repobird-cli/releases/latest/download/repobird_darwin_amd64.tar.gz | tar xz
sudo mv repobird /usr/local/bin/
Linux
Package Managers

Arch Linux (AUR) - Coming Soon

yay -S repobird

Debian/Ubuntu - Available in Releases

# Download the .deb package from releases
wget https://github.com/RepoBird/repobird-cli/releases/latest/download/repobird_VERSION_amd64.deb
sudo dpkg -i repobird_*.deb

Red Hat/Fedora - Available in Releases

# Download the .rpm package from releases
wget https://github.com/RepoBird/repobird-cli/releases/latest/download/repobird_VERSION_x86_64.rpm
sudo rpm -i repobird_*.rpm
Using Install Script
curl -sSL https://raw.githubusercontent.com/RepoBird/repobird-cli/main/scripts/install.sh | bash
Direct Download
# Download latest release for Linux
curl -L https://github.com/RepoBird/repobird-cli/releases/latest/download/repobird_linux_amd64.tar.gz | tar xz
sudo mv repobird /usr/local/bin/
Windows
Using Scoop (Coming Soon)
scoop bucket add repobird https://github.com/RepoBird/scoop-bucket
scoop install repobird
Using Chocolatey (Coming Soon)
choco install repobird
Direct Download

Download the latest Windows ZIP from the releases page and extract repobird.exe.

Build from Source
# Requires Go 1.20+
git clone https://github.com/RepoBird/repobird-cli.git
cd repobird-cli
make build

# Install globally (optional)
sudo cp build/repobird /usr/local/bin/

πŸ—‘οΈ Uninstallation

Using the Uninstall Script

The easiest way to completely remove RepoBird CLI and its data:

# If you have the repository cloned
./scripts/uninstall.sh

# Or download and run the script directly
curl -sSL https://raw.githubusercontent.com/RepoBird/repobird-cli/main/scripts/uninstall.sh | bash

The uninstall script will:

  • Remove the repobird binary and rb alias from your system
  • Delete configuration files (including API keys)
  • Clean up cache directories
  • Prompt for confirmation before each removal
Manual Uninstallation

If you prefer to uninstall manually:

# Remove the binary (location depends on installation method)
sudo rm -f /usr/local/bin/repobird
sudo rm -f /usr/local/bin/rb
# Or if installed with go install
rm -f ~/go/bin/repobird
rm -f ~/go/bin/rb

# Remove configuration and cache
rm -rf ~/.config/repobird
rm -rf ~/.repobird  # Legacy location
Package Manager Uninstallation

For package manager installations:

# Homebrew (macOS)
brew uninstall repobird-cli

# Scoop (Windows)
scoop uninstall repobird

πŸš€ Quick Start

1. Get Your API Key

Sign up for a free account at RepoBird.ai to get your API key.

2. Authenticate
# Interactive login (recommended)
repobird login
# Enter your API key when prompted

# Verify authentication
repobird verify
3. Submit Your First Task
# Create a simple task file
echo '{
  "repository": "your-org/your-repo",
  "prompt": "Add a README file with project documentation"
}' > task.json

# Submit the task
repobird run task.json --follow
4. Monitor Progress
# Launch the interactive dashboard
repobird tui

# Or check status via CLI
repobird status

πŸ“– Usage Guide

Authentication Management
repobird login          # Interactive login with API key
repobird verify         # Verify your API key is valid
repobird info           # Show authentication status
repobird logout         # Remove stored credentials

# Alternative: Use environment variable
export REPOBIRD_API_KEY=your-api-key
Submitting Tasks
# Single task
repobird run task.json --follow

# From different formats
repobird run task.yaml          # YAML format
repobird run task.md            # Markdown with frontmatter
cat task.json | repobird run -  # From stdin

# Bulk operations
repobird bulk tasks.json        # Submit multiple tasks
Monitoring & Management
# Check status
repobird status                 # List all runs
repobird status RUN_ID          # Check specific run
repobird status --follow RUN_ID # Live updates

# Interactive dashboard
repobird tui                    # Launch terminal UI
Terminal UI Navigation

The interactive dashboard provides a rich interface for managing your runs:

Key Action
Tab / β†’ Navigate forward between columns
Shift+Tab / ← Navigate backward
↑ / ↓ Move selection up/down
Enter Select item
f Fuzzy search in current column
n Create new run
r Refresh data
? Show help
q Quit
Example Templates
# Generate example configurations
repobird examples generate minimal -o task.json
repobird examples generate bulk -o bulk.json
repobird examples schema  # View full schema documentation

πŸ“ Task Configuration

Tasks are defined in JSON, YAML, or Markdown files with two required fields:

  • repository - Target repository (format: "owner/repo")
  • prompt - Task description for the AI
Simple Example
{
  "repository": "myorg/webapp",
  "prompt": "Add user authentication with JWT tokens"
}
Advanced Example
{
  "repository": "myorg/webapp",
  "prompt": "Implement OAuth2 authentication",
  "source": "main",
  "target": "feature/oauth",
  "title": "Add OAuth2 support",
  "context": "Use Google and GitHub as providers",
  "files": ["src/auth/", "config/oauth.json"]
}
Bulk Operations

Submit multiple tasks in a single file:

{
  "repository": "myorg/webapp",
  "runs": [
    {"prompt": "Fix login bug", "target": "fix/login"},
    {"prompt": "Add password reset", "target": "feature/reset"},
    {"prompt": "Improve error handling", "target": "fix/errors"}
  ]
}

For complete configuration options and examples, see the Run Configuration Guide.

πŸ›‘οΈ Advanced Features

Duplicate Prevention

RepoBird automatically prevents accidental duplicate submissions:

  • File content hashing detects when you're re-running the same task
  • Visual indicators in the TUI show duplicate status
  • Easy override option when you intentionally want to re-run
Smart Caching
  • Local caching reduces API calls and improves performance
  • Repository and run data cached for quick access
  • Automatic cache invalidation on updates
Retry Logic
  • Automatic exponential backoff for transient failures
  • Configurable retry attempts and timeouts
  • Graceful handling of rate limits

πŸ“š Documentation

Getting Started
User Guides
Reference
Development

🀝 Contributing

We welcome contributions! RepoBird CLI is open source and community-driven.

How to Contribute
  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to your branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

Please read our Contributing Guidelines for details on our code of conduct and development process.

Development Setup
# Clone your fork
git clone https://github.com/your-username/repobird-cli.git
cd repobird-cli

# Install dependencies
make deps

# Run tests
make test

# Build locally
make build

πŸ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.

🌟 Support

πŸ™ Acknowledgments

Built with:


Made with ❀️ by the RepoBird team

Directories ΒΆ

Path Synopsis
cmd
repobird command
internal
api
tui
tui/components
Package components provides reusable UI components for the TUI
Package components provides reusable UI components for the TUI
pkg
tests

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL