blob: 5c5ee5d91054d0d71d4a0992629a4d4f237de3ae [file] [log] [blame] [view]
Mike Frysingerbefaec12016-08-16 00:08:37 -04001# repo
2
3Repo is a tool built on top of Git. Repo helps manage many Git repositories,
4does the uploads to revision control systems, and automates parts of the
5development workflow. Repo is not meant to replace Git, only to make it
6easier to work with Git. The repo command is an executable Python script
7that you can put anywhere in your path.
8
Mike Frysingerc102fd52020-02-15 14:30:06 -05009* Homepage: <https://gerrit.googlesource.com/git-repo/>
Mike Frysinger4c418bf2020-02-24 12:52:49 -050010* Mailing list: [repo-discuss on Google Groups][repo-discuss]
Mike Frysinger696e0c42023-06-14 17:08:27 -040011* Bug reports: <https://issues.gerritcodereview.com/issues?q=is:open%20componentid:1370071>
Mike Frysingerc102fd52020-02-15 14:30:06 -050012* Source: <https://gerrit.googlesource.com/git-repo/>
13* Overview: <https://source.android.com/source/developing.html>
14* Docs: <https://source.android.com/source/using-repo.html>
Mike Frysinger3891b752018-10-05 19:26:15 -040015* [repo Manifest Format](./docs/manifest-format.md)
Mike Frysinger84e7e162017-11-10 21:28:41 -050016* [repo Hooks](./docs/repo-hooks.md)
Mike Frysingerbefaec12016-08-16 00:08:37 -040017* [Submitting patches](./SUBMITTING_PATCHES.md)
Mike Frysinger7ac12a92019-12-04 18:34:07 -050018* Running Repo in [Microsoft Windows](./docs/windows.md)
Mike Frysingerb57e6332020-02-15 13:49:10 -050019* GitHub mirror: <https://github.com/GerritCodeReview/git-repo>
20* Postsubmit tests: <https://github.com/GerritCodeReview/git-repo/actions>
Mike Frysinger34bc5712019-11-18 02:27:57 -050021
Mike Frysinger4c418bf2020-02-24 12:52:49 -050022## Contact
23
24Please use the [repo-discuss] mailing list or [issue tracker] for questions.
25
26You can [file a new bug report][new-bug] under the "repo" component.
27
28Please do not e-mail individual developers for support.
29They do not have the bandwidth for it, and often times questions have already
30been asked on [repo-discuss] or bugs posted to the [issue tracker].
31So please search those sites first.
32
Mike Frysinger34bc5712019-11-18 02:27:57 -050033## Install
34
35Many distros include repo, so you might be able to install from there.
36```sh
37# Debian/Ubuntu.
38$ sudo apt-get install repo
39
40# Gentoo.
41$ sudo emerge dev-vcs/repo
42```
43
44You can install it manually as well as it's a single script.
45```sh
46$ mkdir -p ~/.bin
47$ PATH="${HOME}/.bin:${PATH}"
48$ curl https://storage.googleapis.com/git-repo-downloads/repo > ~/.bin/repo
49$ chmod a+rx ~/.bin/repo
50```
Mike Frysinger4c418bf2020-02-24 12:52:49 -050051
52
Mike Frysinger696e0c42023-06-14 17:08:27 -040053[new-bug]: https://issues.gerritcodereview.com/issues/new?component=1370071
54[issue tracker]: https://issues.gerritcodereview.com/issues?q=is:open%20componentid:1370071
Mike Frysinger4c418bf2020-02-24 12:52:49 -050055[repo-discuss]: https://groups.google.com/forum/#!forum/repo-discuss