* Copyright (C) the libgit2 contributors. All rights reserved.
* This file is part of libgit2, distributed under the GNU GPL v2 with
* a Linking Exception. For full terms see the included COPYING file.
#ifndef INCLUDE_git_clone_h__
#define INCLUDE_git_clone_h__
* @brief Git cloning routines
* @defgroup git_clone Git cloning routines
* Options for bypassing the git-aware transport on clone. Bypassing
* it means that instead of a fetch, libgit2 will copy the object
* database directory instead of figuring out what it needs, which is
* faster. If possible, it will hardlink the files to save space.
* Auto-detect (default), libgit2 will bypass the git-aware
* transport for local paths, but use a normal fetch for
* Bypass the git-aware transport even for a `file://` url.
* Do no bypass the git-aware transport
* Bypass the git-aware transport, but do not try to use
GIT_CLONE_LOCAL_NO_LINKS,
* The signature of a function matching git_remote_create, with an additional
* void* as a callback payload.
* Callers of git_clone may provide a function matching this signature to override
* the remote creation and customization process during a clone operation.
* @param out the resulting remote
* @param repo the repository in which to create the remote
* @param name the remote's name
* @param url the remote's url
* @param payload an opaque payload
* @return 0, GIT_EINVALIDSPEC, GIT_EEXISTS or an error code
typedef int GIT_CALLBACK(git_remote_create_cb)(
* The signature of a function matchin git_repository_init, with an
* aditional void * as callback payload.
* Callers of git_clone my provide a function matching this signature
* to override the repository creation and customization process
* during a clone operation.
* @param out the resulting repository
* @param path path in which to create the repository
* @param bare whether the repository is bare. This is the value from the clone options
* @param payload payload specified by the options
* @return 0, or a negative value to indicate error
typedef int GIT_CALLBACK(git_repository_create_cb)(
* Clone options structure
* Initialize with `GIT_CLONE_OPTIONS_INIT`. Alternatively, you can
* use `git_clone_options_init`.
typedef struct git_clone_options {
* These options are passed to the checkout step. To disable
* checkout, set the `checkout_strategy` to
git_checkout_options checkout_opts;
* Options which control the fetch, including callbacks.
* The callbacks are used for reporting fetch progress, and for acquiring
* credentials in the event they are needed.
git_fetch_options fetch_opts;
* Set to zero (false) to create a standard repo, or non-zero
* Whether to use a fetch or copy the object database.
* The name of the branch to checkout. NULL means use the
* remote's default branch.
const char* checkout_branch;
* A callback used to create the new repository into which to
* clone. If NULL, the 'bare' field will be used to determine
* whether to create a bare repository.
git_repository_create_cb repository_cb;
* An opaque payload to pass to the git_repository creation callback.
* This parameter is ignored unless repository_cb is non-NULL.
void *repository_cb_payload;
* A callback used to create the git_remote, prior to its being
* used to perform the clone operation. See the documentation for
* git_remote_create_cb for details. This parameter may be NULL,
* indicating that git_clone should provide default behavior.
git_remote_create_cb remote_cb;
* An opaque payload to pass to the git_remote creation callback.
* This parameter is ignored unless remote_cb is non-NULL.
#define GIT_CLONE_OPTIONS_VERSION 1
#define GIT_CLONE_OPTIONS_INIT { GIT_CLONE_OPTIONS_VERSION, \
{ GIT_CHECKOUT_OPTIONS_VERSION, GIT_CHECKOUT_SAFE }, \
* Initialize git_clone_options structure
* Initializes a `git_clone_options` with default values. Equivalent to creating
* an instance with GIT_CLONE_OPTIONS_INIT.
* @param opts The `git_clone_options` struct to initialize.
* @param version The struct version; pass `GIT_CLONE_OPTIONS_VERSION`.
* @return Zero on success; -1 on failure.
GIT_EXTERN(int) git_clone_options_init(
* Clone a remote repository.
* By default this creates its repository and initial remote to match
* git's defaults. You can use the options in the callback to
* customize how these are created.
* @param out pointer that will receive the resulting repository object
* @param url the remote repository to clone
* @param local_path local directory to clone to
* @param options configuration options for the clone. If NULL, the
* function works as though GIT_OPTIONS_INIT were passed.
* @return 0 on success, any non-zero return value from a callback
* function, or a negative value to indicate an error (use
* `git_error_last` for a detailed error message)
GIT_EXTERN(int) git_clone(
const git_clone_options *options);
It is recommended that you Edit text format, this type of Fix handles quite a lot in one request
