setup-repo¶
New in version 0.5.3.
rbt setup-repo will interactively configure your repository to point
to a Review Board server by generating or overwriting the configuration file
.reviewboardrc in the current working directory.
Usage¶
$ rbt setup-repo [options]
Configuring repositories on your server¶
Prior to running setup-repo, ensure that your repositories are configured
on the Review Board server you wish to connect to. RBTools will not find
repositories that have not been added to the server.
If you are an RBCommons customer, you can add repositories under your team administration settings. If you are managing your own deployment of Review Board, refer to the Admin Dashboard. Learn more about configuring repositories.
Setting up your server¶
If REVIEWBOARD_URL is not defined in your
.reviewboardrc, you will be prompted to enter the URL of a valid
Review Board server you want to connect to. Alternatively, you may use
--server to skip this prompt.
Note that if you use RBCommons, you will need to verify your RBCommons credentials first.
Selecting a repository¶
If RBTools finds multiple repositories in your Review Board server, you can select which repository you want to use. If no repositories are found, this means that you currently have no repositories configured on your server (see configuring repositories on your server).
When you select a repository, you will be prompted to confirm the repository
of your choice, as well as any changes to your current .reviewboardrc
configuration file. Confirming will generate or update your .reviewboardrc
with information related to your chosen repository.
After generating .reviewboardrc¶
Thanks to your newly generated .reviewboardrc file, you can now use
RBTools to communicate between your chosen repository and your Review
Board server.
Options¶
- -d, --debug¶
Displays debug output.
This information can be valuable when debugging problems running the command.
The default can be set in
DEBUGin .reviewboardrc.
- --json¶
Output results as JSON data instead of text.
The default can be set in
JSON_OUTPUTin .reviewboardrc.New in version 3.0.
Review Board Server Options¶
Options necessary to communicate and authenticate with a Review Board server.
- --server <url>¶
Specifies the Review Board server to use.
The default can be set in
REVIEWBOARD_URLin .reviewboardrc.
- --username <username>¶
The user name to be supplied to the Review Board server.
The default can be set in
USERNAMEin .reviewboardrc.
- --password <password>¶
The password to be supplied to the Review Board server.
The default can be set in
PASSWORDin .reviewboardrc.
- --ext-auth-cookies <ext auth cookies>¶
Use an external cookie store with pre-fetched authentication data. This is useful with servers that require extra web authentication to access Review Board, e.g. on single sign-on enabled sites.
The default can be set in
EXT_AUTH_COOKIESin .reviewboardrc.New in version 0.7.5.
- --api-token <token>¶
The API token to use for authentication, instead of using a username and password.
The default can be set in
API_TOKENin .reviewboardrc.New in version 0.7.
- --disable-proxy¶
Prevents requests from going through a proxy server.
The default can be set in
ENABLE_PROXYin .reviewboardrc.
- --disable-ssl-verification¶
Disable SSL certificate verification. This is useful with servers that have self-signed certificates.
The default can be set in
DISABLE_SSL_VERIFICATIONin .reviewboardrc.New in version 0.7.3.
- --disable-cookie-storage¶
Use an in-memory cookie store instead of writing them to a file. No credentials will be saved or loaded.
The default can be set in
SAVE_COOKIESin .reviewboardrc.New in version 0.7.3.
- --disable-cache¶
Disable the HTTP cache completely. This will result in slower requests.
The default can be set in
DISABLE_CACHEin .reviewboardrc.New in version 0.7.3.
- --disable-cache-storage¶
Disable storing the API cache on the filesystem, instead keeping it in memory temporarily.
The default can be set in
IN_MEMORY_CACHEin .reviewboardrc.New in version 0.7.3.
- --cache-location <file>¶
The file to use for the API cache database.
The default can be set in
CACHE_LOCATIONin .reviewboardrc.New in version 0.7.3.
- --ca-certs <file>¶
Additional TLS CA bundle.
The default can be set in
CA_CERTSin .reviewboardrc.
- --client-key <file>¶
Key for TLS client authentication.
The default can be set in
CLIENT_KEYin .reviewboardrc.
- --client-cert <file>¶
Certificate for TLS client authentication.
The default can be set in
CLIENT_CERTin .reviewboardrc.
- --proxy-authorization <proxy authorization>¶
Value of the Proxy-Authorization header to send with HTTP requests.
The default can be set in
PROXY_AUTHORIZATIONin .reviewboardrc.
Perforce Options¶
Perforce-specific options for selecting the Perforce client and communicating with the repository.
- --p4-client <client name>¶
The Perforce client name for the repository.
The default can be set in
P4_CLIENTin .reviewboardrc.
- --p4-port <port>¶
The IP address for the Perforce server.
The default can be set in
P4_PORTin .reviewboardrc.
- --p4-passwd <password>¶
The Perforce password or ticket of the user in the P4USER environment variable.
The default can be set in
P4_PASSWDin .reviewboardrc.
TFS Options¶
Team Foundation Server specific options for communicating with the TFS server.
- --tfs-login <tfs login>¶
Logs in to TFS as a specific user (ie.user@domain,password). Visit https://msdn.microsoft.com/en-us/library/hh190725.aspx to learn about saving credentials for reuse.
- --tf-cmd <tf cmd>¶
The full path of where to find the tf command. This overrides any detected path.
The default can be set in
TF_CMDin .reviewboardrc.
- --tfs-shelveset-owner <tfs shelveset owner>¶
When posting a shelveset name created by another user (other than the one who owns the current workdir), look for that shelveset using this username.