Skip to content

Getting Started

Welcome to GitBridge! This section will help you get up and running quickly.

Quick Navigation

Prerequisites

Before you begin, ensure you have:

  • Python 3.10 or higher installed
  • Network access to GitHub.com (via browser)
  • A GitHub repository you want to sync
  • (Optional) GitHub Personal Access Token for private repositories

Installation Options

Bash
1
pip install gitbridge
Bash
1
2
3
4
5
# Install uv first
curl -LsSf https://astral.sh/uv/install.sh | sh

# Install gitbridge
uv pip install gitbridge
Bash
1
2
3
git clone https://github.com/nevedomski/gitbridge
cd gitbridge
pip install -e .

Your First Sync

The simplest way to sync a repository:

Bash
1
gitbridge sync --repo https://github.com/python/cpython --local ~/cpython

This will:

  1. Connect to the GitHub repository
  2. Download all files to your local directory
  3. Create a .gitbridge metadata file for tracking
  4. Show progress with a nice progress bar

That's it!

You've successfully synced your first repository! The next sync will only download changed files.

What's Next?

After your first successful sync, explore these topics:

Getting Help

If you run into issues:

  1. Check the Troubleshooting Guide
  2. Search existing issues
  3. Ask for help by creating an issue

Pro Tip

Use gitbridge --help to see all available commands and options at any time.