Google Git
Sign in
gerrit/git-repo/a98e4221139765f4475d7c0a524b59c688077e75
commit
a98e4221139765f4475d7c0a524b59c688077e75
[log]
author
Gavin Mak <gavinmak@google.com>
Fri May 08 19:39:58 2026 +0000
committer
gerrit-scoped@luci-project-accounts.iam.gserviceaccount.com <gerrit-scoped@luci-project-accounts.iam.gserviceaccount.com>
Fri May 08 17:41:44 2026 -0700
tree
73284468dfa2078d18020691be3191639aa5af9f
parent
5d8585012f384d1e2566f9c0b7ad7c0efcc5edd2 [diff]
completion: document installation and usage in README

Add a "Shell Completion" section to README.md to document how to install
and use `completion.bash` and `completion.zsh`.

Change-Id: Ibf6c81043af6c24d45ea2dc6a6caa26d98ab7374
Reviewed-on: https://gerrit-review.googlesource.com/c/git-repo/+/581261
Tested-by: Gavin Mak <gavinmak@google.com>
Reviewed-by: Mike Frysinger <vapier@google.com>
Commit-Queue: Gavin Mak <gavinmak@google.com>
1 file changed
tree: 73284468dfa2078d18020691be3191639aa5af9f
  1. .github/
  2. docs/
  3. hooks/
  4. man/
  5. release/
  6. subcmds/
  7. tests/
  8. .flake8
  9. .gitattributes
  10. .gitignore
  11. .gitreview
  12. .mailmap
  13. .project
  14. .pydevproject
  15. color.py
  16. command.py
  17. completion.bash
  18. completion.zsh
  19. constraints.txt
  20. CONTRIBUTING.md
  21. editor.py
  22. error.py
  23. event_log.py
  24. fetch.py
  25. git_command.py
  26. git_config.py
  27. git_refs.py
  28. git_ssh
  29. git_superproject.py
  30. git_trace2_event_log.py
  31. git_trace2_event_log_base.py
  32. hooks.py
  33. LICENSE
  34. main.py
  35. MANIFEST.in
  36. manifest_xml.py
  37. pager.py
  38. platform_utils.py
  39. platform_utils_win32.py
  40. progress.py
  41. project.py
  42. pyproject.toml
  43. README.md
  44. repo
  45. repo_logging.py
  46. repo_trace.py
  47. requirements.json
  48. run_tests
  49. run_tests.vpython3
  50. run_tests.vpython3.8
  51. setup.py
  52. ssh.py
  53. wrapper.py
README.md

repo

Repo is a tool built on top of Git. Repo helps manage many Git repositories, does the uploads to revision control systems, and automates parts of the development workflow. Repo is not meant to replace Git, only to make it easier to work with Git. The repo command is an executable Python script that you can put anywhere in your path.

Contact

Please use the repo-discuss mailing list or issue tracker for questions.

You can file a new bug report under the “repo” component.

Please do not e-mail individual developers for support. They do not have the bandwidth for it, and often times questions have already been asked on repo-discuss or bugs posted to the issue tracker. So please search those sites first.

Install

Many distros include repo, so you might be able to install from there.

# Debian/Ubuntu.
$ sudo apt-get install repo

# Gentoo.
$ sudo emerge dev-vcs/repo

You can install it manually as well as it's a single script.

$ mkdir -p ~/.bin
$ PATH="${HOME}/.bin:${PATH}"
$ curl https://storage.googleapis.com/git-repo-downloads/repo > ~/.bin/repo
$ chmod a+rx ~/.bin/repo

Shell Completion

Repo includes completion scripts for Bash and Zsh.

Bash

To enable completion in Bash, source completion.bash in your ~/.bashrc:

source /path/to/git-repo/completion.bash

Zsh

To enable completion in Zsh, you can either:

  1. Copy or symlink completion.zsh to a file named _repo in a directory in your $fpath:

    mkdir -p ~/.zsh/completion
# You can copy the file:
cp /path/to/git-repo/completion.zsh ~/.zsh/completion/_repo
# Or symlink it:
ln -s /path/to/git-repo/completion.zsh ~/.zsh/completion/_repo

    Then add that directory to your fpath in ~/.zshrc before compinit:

    fpath=(~/.zsh/completion $fpath)
autoload -Uz compinit
compinit

  2. Or source the file directly and call compdef in your ~/.zshrc:

    source /path/to/git-repo/completion.zsh
compdef _repo repo