NAME
git-bundle - Move objects and refs by archiveSYNOPSIS
git bundle create [-q | --quiet | --progress | --all-progress] [--all-progress-implied] [--version=<version>] <file> <git-rev-list-args> git bundle verify [-q | --quiet] <file> git bundle list-heads <file> [<refname>...] git bundle unbundle [--progress] <file> [<refname>...]
DESCRIPTION
Create, unpack, and manipulate "bundle" files. Bundles are used for the "offline" transfer of Git objects without an active "server" sitting on the other side of the network connection.BUNDLE FORMAT
Bundles are .pack files (see git-pack-objects(1)) with a header indicating what references are contained within the bundle.OPTIONS
create [options] <file> <git-rev-list-args>Used to create a bundle named file.
This requires the <git-rev-list-args> arguments to define the
bundle contents. options contains the options specific to the git
bundle create subcommand.
verify <file>
Used to check that a bundle file is valid and
will apply cleanly to the current repository. This includes checks on the
bundle format itself as well as checking that the prerequisite commits exist
and are fully linked in the current repository. Then, git bundle prints
a list of missing commits, if any. Finally, information about additional
capabilities, such as "object filter", is printed. See
"Capabilities" in gitformat-bundle(5) for more information.
The exit code is zero for success, but will be nonzero if the bundle file is
invalid.
list-heads <file>
Lists the references defined in the bundle. If
followed by a list of references, only references matching those given are
printed out.
unbundle <file>
Passes the objects in the bundle to git
index-pack for storage in the repository, then prints the names of all
defined references. If a list of references is given, only references matching
those in the list are printed. This command is really plumbing, intended to be
called only by git fetch.
<git-rev-list-args>
A list of arguments, acceptable to git
rev-parse and git rev-list (and containing a named ref, see
SPECIFYING REFERENCES below), that specifies the specific objects and
references to transport. For example, master~10..master causes the
current master reference to be packaged along with all objects added since its
10th ancestor commit. There is no explicit limit to the number of references
and objects that may be packaged.
[<refname>...]
A list of references used to limit the
references reported as available. This is principally of use to git
fetch, which expects to receive only those references asked for and not
necessarily everything in the pack (in this case, git bundle acts like
git fetch-pack).
--progress
Progress status is reported on the standard
error stream by default when it is attached to a terminal, unless -q is
specified. This flag forces progress status even if the standard error stream
is not directed to a terminal.
--all-progress
When --stdout is specified then progress
report is displayed during the object count and compression phases but
inhibited during the write-out phase. The reason is that in some cases the
output stream is directly linked to another command which may wish to display
progress status of its own as it processes incoming pack data. This flag is
like --progress except that it forces progress report for the write-out phase
as well even if --stdout is used.
--all-progress-implied
This is used to imply --all-progress whenever
progress display is activated. Unlike --all-progress this flag doesn’t
actually force any progress display by itself.
--version=<version>
Specify the bundle version. Version 2 is the
older format and can only be used with SHA-1 repositories; the newer version 3
contains capabilities that permit extensions. The default is the oldest
supported format, based on the hash algorithm in use.
-q, --quiet
This flag makes the command not to report its
progress on the standard error stream.
SPECIFYING REFERENCES
Revisions must be accompanied by reference names to be packaged in a bundle.$ git bundle create master.bundle master $ echo master | git bundle create master.bundle --stdin $ git bundle create master-and-next.bundle master next $ (echo master; echo next) | git bundle create master-and-next.bundle --stdin
$ git bundle create recent-master.bundle master~10..master $ git bundle create recent-updates.bundle master~10..master next~5..next
$ git bundle create HEAD.bundle $(git rev-parse HEAD) fatal: Refusing to create empty bundle. $ git bundle create master-yesterday.bundle master~10..master~5 fatal: Refusing to create empty bundle.
OBJECT PREREQUISITES
When creating bundles it is possible to create a self-contained bundle that can be unbundled in a repository with no common history, as well as providing negative revisions to exclude objects needed in the earlier parts of the history.$ git bundle create full.bundle new
$ git bundle create full.bundle old..new
EXAMPLES
Assume you want to transfer the history from a repository R1 on machine A to another repository R2 on machine B. For whatever reason, direct connection between A and B is not allowed, but we can move data from A to B via some mechanism (CD, email, etc.). We want to update R2 with development made on the branch master in R1.machineA$ cd R1 machineA$ git bundle create file.bundle master machineA$ git tag -f lastR2bundle master
machineB$ git clone -b master /home/me/tmp/file.bundle R2
[remote "origin"] url = /home/me/tmp/file.bundle fetch = refs/heads/*:refs/remotes/origin/*
machineA$ cd R1 machineA$ git bundle create file.bundle lastR2bundle..master machineA$ git tag -f lastR2bundle master
machineB$ cd R2 machineB$ git pull
$ git bundle create mybundle v1.0.0..master
$ git bundle create mybundle --since=10.days master
$ git bundle create mybundle -10 master
$ git bundle verify mybundle
$ git fetch mybundle master:localRef
$ git ls-remote mybundle
FILE FORMAT
See gitformat-bundle(5).GIT
Part of the git(1) suite02/28/2023 | Git 2.39.2 |