JIYIK CN >

In this article, we will discuss exporting a project in Git. We use git archivethe command to create an archive file of our Git repository.

Such a file combines several files into one. Archive files are convenient for sharing between developers or for long-term storage.

git archiveOrder

What does it do?

We use git archivethe command to generate archive files such as commits, branches, and trees for the specified ref. The command can be used with other parameters to change the output as shown below.

Git export example

Let's start with a basic git archivecommand.

$ git archive --format=tar HEAD

If we execute this command on the terminal, it will HEADcreate an archive file from the in our repository. The archive will go to our temporary stdoutstream.

We can specify a permanent file as shown below.

$ git archive --output=./sample_repo_archive.tar --format=tar HEAD

HEADWhen the above command is executed, it will create an archive file for our refs and store it sample_repo_archive.tarin the file. --format=tarThe option instructs Git to generate an uncompressed archive output.

We can pass other popular formats like zipand tar.gzto our format option. If we don't include the format option, Git will handle the specified --outputoption.

$ git archive --output=./sample_repo_archive.tar.gz --format=tar HEAD ./Updates

Git also makes it possible to archive parts of our repository. The command above will /.Updatescreate an archive file of the files in the directory of our repository.

Git Archive Usage Options

The above examples give us git archivea basic idea of ​​the most commonly used options. Let's explore another option that can be passed to the command to further alter the output.

--prefix=<prefix>/

We use prefixthe -p parameter to append the paths to all the files in our archive for easier extraction.

--remote=<repo>

This is the preferred command in scenarios where we want to create an archive of a remote repository. When running the command, we must include the URL of the remote repository.

This command also allows us to point to refs in remote repositories.

Command Configuration

git archiveThe command follows the following configuration options.

$ git config --global tar.umask

We use the unmask configuration to specify Unix-level permission bit restrictions for the archive.

tar.<format>.command

We use the options above to create a custom shell command that will run our git archive. This is the same as stdoutpiping the ./stream to a custom tool and omitting the ./stream --outputoption.

The basic concept of this operation is to create a fixed custom archive post-processing tool.

tar.<format>.remote

We can enable the option above to allow remote developers 格式to fetch archives with the specified .

In short, we use git archivethe command to generate a distributable package of a Git repository. We can use this command to target a specific tree, branch, or commit.

It also has multiple output formats for increased compression.