Scroll to navigation

REPO(1) Repo Manual REPO(1)

NAME

repo - repo forall - manual page for repo forall

SYNOPSIS

repo forall [<project>...] -c <command> [<arg>...]

DESCRIPTION

Summary

Run a shell command in each project

repo forall -r str1 [str2] ... -c <command> [<arg>...]

OPTIONS

show this help message and exit
number of jobs to run in parallel (default: based on number of CPU cores)
execute the command only on projects matching regex or wildcard expression
execute the command only on projects not matching regex or wildcard expression
execute the command only on projects matching the specified groups
command (and arguments) to execute
abort if a command exits unsuccessfully
silently skip & do not exit non-zero due missing checkouts
force interactive usage

Logging options:

show all output
only show errors
show project headers before output

Run `repo help forall` to view the detailed manual.

DETAILS

Executes the same shell command in each project.

The -r option allows running the command only on projects matching regex or wildcard expression.

By default, projects are processed non-interactively in parallel. If you want to run interactive commands, make sure to pass --interactive to force --jobs 1. While the processing order of projects is not guaranteed, the order of project output is stable.

Output Formatting

The -p option causes 'repo forall' to bind pipes to the command's stdin, stdout and stderr streams, and pipe all output into a continuous stream that is displayed in a single pager session. Project headings are inserted before the output of each command is displayed. If the command produces no output in a project, no heading is displayed.

The formatting convention used by -p is very suitable for some types of searching, e.g. `repo forall -p -c git log -SFoo` will print all commits that add or remove references to Foo.

The -v option causes 'repo forall' to display stderr messages if a command produces output only on stderr. Normally the -p option causes command output to be suppressed until the command produces at least one byte of output on stdout.

Environment

pwd is the project's working directory. If the current client is a mirror client, then pwd is the Git repository.

REPO_PROJECT is set to the unique name of the project.

REPO_PATH is the path relative the the root of the client.

REPO_REMOTE is the name of the remote system from the manifest.

REPO_LREV is the name of the revision from the manifest, translated to a local tracking branch. If you need to pass the manifest revision to a locally executed git command, use REPO_LREV.

REPO_RREV is the name of the revision from the manifest, exactly as written in the manifest.

REPO_COUNT is the total number of projects being iterated.

REPO_I is the current (1-based) iteration count. Can be used in conjunction with REPO_COUNT to add a simple progress indicator to your command.

REPO__* are any extra environment variables, specified by the "annotation" element under any project element. This can be useful for differentiating trees based on user-specific criteria, or simply annotating tree details.

shell positional arguments ($1, $2, .., $#) are set to any arguments following <command>.

Example: to list projects:

repo forall -c 'echo $REPO_PROJECT'

Notice that $REPO_PROJECT is quoted to ensure it is expanded in the context of running <command> instead of in the calling shell.

Unless -p is used, stdin, stdout, stderr are inherited from the terminal and are not redirected.

If -e is used, when a command exits unsuccessfully, 'repo forall' will abort without iterating through the remaining projects.

July 2021 repo forall