Git & GitHub - Git Bundle

How to use git bundle for offline transfers

Git bundle allows you to create a single file that contains the entire repository or specific parts of it. This is useful for transferring a repository without network access. This guide covers how to create, transfer, and apply git bundles.

Creating a Git Bundle

Step 1: Bundle the Entire Repository

To create a bundle of the entire repository, use the git bundle create command followed by the bundle file name and --all:

# Create a bundle of the entire repository
$ git bundle create repo.bundle --all
                

Step 2: Bundle Specific Branches or Tags

To create a bundle of specific branches or tags, specify them after the bundle file name:

# Create a bundle of specific branches
$ git bundle create repo.bundle main feature-branch

# Create a bundle of a specific tag
$ git bundle create repo.bundle v1.0
                

Transferring the Bundle

Once the bundle file is created, transfer it to the target machine using any method (e.g., USB drive, email, file transfer service):

# Example: Transfer the bundle file via USB
$ cp repo.bundle /media/usb-drive/
                

Using the Bundle

Step 1: Clone from the Bundle

To clone a new repository from the bundle, use the git clone command followed by the bundle file path:

# Clone a new repository from the bundle
$ git clone repo.bundle new-repo
                

Step 2: Fetch Updates from the Bundle

To fetch updates from the bundle into an existing repository, use the git fetch command followed by the bundle file path:

# Fetch updates from the bundle
$ git fetch repo.bundle main
                

After fetching, you can merge or checkout the updates as needed:

# Merge the fetched updates
$ git merge FETCH_HEAD

# Checkout the fetched branch
$ git checkout main
                

Advanced Usage

Creating Incremental Bundles

You can create incremental bundles that contain only the changes since a specific commit:

# Create an incremental bundle
$ git bundle create repo-incremental.bundle --since=commit_hash
                

Verifying a Bundle

Before using a bundle, you can verify its contents with the git bundle verify command:

# Verify the bundle contents
$ git bundle verify repo.bundle
                

Best Practices

Follow these best practices when using git bundle:

• Verify Bundles: Always verify the contents of a bundle before using it to ensure its integrity.
• Keep Bundles Secure: Since bundles can contain the entire repository, keep them secure during transfer and storage.
• Use Descriptive Names: Use descriptive names for bundle files to easily identify their contents and purpose.
• Document Bundle Usage: Document the process of creating and using bundles to help team members understand their purpose and usage.

Summary

This guide covered how to use git bundle for offline transfers, including creating bundles, transferring them, and using them to clone or fetch updates. Git bundle is a powerful tool for managing repositories in environments without network access, enabling efficient and secure offline transfers.