blob: e860f95d3e294129547124dcc7744702806981e4 [file] [log] [blame]
.\" DO NOT MODIFY THIS FILE! It was generated by help2man.
.TH REPO "1" "July 2021" "repo init" "Repo Manual"
repo \- repo init - manual page for repo init
.B repo
\fI\,init \/\fR[\fI\,options\/\fR] [\fI\,manifest url\/\fR]
Initialize a repo client checkout in the current directory
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.SS Logging options:
\fB\-v\fR, \fB\-\-verbose\fR
show all output
\fB\-q\fR, \fB\-\-quiet\fR
only show errors
.SS Manifest options:
\fB\-u\fR URL, \fB\-\-manifest\-url\fR=\fI\,URL\/\fR
manifest repository location
\fB\-b\fR REVISION, \fB\-\-manifest\-branch\fR=\fI\,REVISION\/\fR
manifest branch or revision (use HEAD for default)
\fB\-m\fR NAME.xml, \fB\-\-manifest\-name\fR=\fI\,NAME\/\fR.xml
initial manifest file
\fB\-g\fR GROUP, \fB\-\-groups\fR=\fI\,GROUP\/\fR
restrict manifest projects to ones with specified
group(s) [default|all|G1,G2,G3|G4,\-G5,\-G6]
\fB\-p\fR PLATFORM, \fB\-\-platform\fR=\fI\,PLATFORM\/\fR
restrict manifest projects to ones with a specified
platform group [auto|all|none|linux|darwin|...]
sync any submodules associated with the manifest repo
.SS Manifest (only) checkout options:
\fB\-c\fR, \fB\-\-current\-branch\fR
fetch only current manifest branch from server
fetch all manifest branches from server
fetch tags in the manifest
don't fetch tags in the manifest
.SS Checkout modes:
create a replica of the remote repositories rather
than a client working directory
checkout an archive instead of a git repository for
each project. See git archive.
use git\-worktree to manage projects
.SS Project checkout optimizations:
location of mirror directory
dissociate from reference mirrors after clone
create a shallow clone with given depth; see git clone
perform partial clone (
disable use of partial clone (
exclude the specified projects (a comma\-delimited
project names) from partial clone (
filter for use with \fB\-\-partial\-clone\fR [default:
use the manifest superproject to sync projects
disable use of manifest superprojects
enable use of \fI\,/clone.bundle\/\fP on HTTP/HTTPS (default if
not \fB\-\-partial\-clone\fR)
disable use of \fI\,/clone.bundle\/\fP on HTTP/HTTPS (default if
.SS repo Version options:
repo repository location ($REPO_URL)
repo branch or revision ($REPO_REV)
do not verify repo source code
.SS Other options:
Always prompt for name/e\-mail
Run `repo help init` to view the detailed manual.
The 'repo init' command is run once to install and initialize repo. The latest
repo source code and manifest collection is downloaded from the server and is
installed in the .repo/ directory in the current working directory.
When creating a new checkout, the manifest URL is the only required setting. It
may be specified using the \fB\-\-manifest\-url\fR option, or as the first optional
The optional \fB\-b\fR argument can be used to select the manifest branch to checkout
and use. If no branch is specified, the remote's default branch is used. This is
equivalent to using \fB\-b\fR HEAD.
The optional \fB\-m\fR argument can be used to specify an alternate manifest to be
used. If no manifest is specified, the manifest default.xml will be used.
The \fB\-\-reference\fR option can be used to point to a directory that has the content
of a \fB\-\-mirror\fR sync. This will make the working directory use as much data as
possible from the local reference directory when fetching from the server. This
will make the sync go a lot faster by reducing data traffic on the network.
The \fB\-\-dissociate\fR option can be used to borrow the objects from the directory
specified with the \fB\-\-reference\fR option only to reduce network transfer, and stop
borrowing from them after a first clone is made by making necessary local copies
of borrowed objects.
The \fB\-\-no\-clone\-bundle\fR option disables any attempt to use \fI\,$URL/clone.bundle\/\fP to
bootstrap a new Git repository from a resumeable bundle file on a content
delivery network. This may be necessary if there are problems with the local
Python HTTP client or proxy configuration, but the Git binary works.
Switching Manifest Branches
To switch to another manifest branch, `repo init \fB\-b\fR otherbranch` may be used in
an existing client. However, as this only updates the manifest, a subsequent
`repo sync` (or `repo sync \fB\-d\fR`) is necessary to update the working directory