RBTools is a set of command line tools for working with Review Board and RBCommons. It’s there to help quickly get your code up for review, check on the status of changes, and eventually land your code in the codebase, amongst other uses.
RBTools interfaces with your repository’s official command line tools, making it easy to generate suitable diffs or to apply changes across any supported type of repository without having to learn different sets of tools.
Along with a variety of helpful commands, RBTools also provides a powerful Python client API for Review Board, giving you the flexibility to develop your own integrations.
What’s in RBTools¶
All the RBTools commands are invoked through the rbt tool. This runs on Windows, Linux, and MacOS X, and contains a number of useful sub-commands through the following usage:
$ rbt <command> [options] [<args>]
You can get help on rbt or a sub-command in the following ways:
$ rbt help $ rbt help <command> $ rbt <command> --help
Some of the most commonly-used commands include:
- post - Posts changes to Review Board
- diff - Displays the diff that will be sent to Review Board
- land - Lands a change in a local branch or on a review request
- patch - Patches your tree with a change on a review request
- setup-repo - Sets up RBTools to talk to your repository
There are many other commands you may find useful. See the full list of commands.
RBTools provides a Python module makes it easy to communicate with any Review Board server using its powerful REST API. You can write custom scripts or even new RBTools command that can attach metadata to review requests, perform reviews, analyze diffs, extract analytics data, or almost anything else.
There’s a lot you can do with the API. See the RBTools Python API documentation for more information.
To install RBTools, simply visit the RBTools Downloads page and follow the instructions for your operating system. If you are using MacOS X or Windows, just run the installer and you’ll be set.
If you’re using Microsoft’s Team Foundation Server, there’s some extra installation or configuration that may be necessary.
Once you’ve installed RBTools, you’ll want to configure it to work with your repositories. This is the first step to allow any of your developers to easily post changes using RBTools.