login¶
Changed in version 5.0: The login command can now direct the user to log in via the Review Board web page, instead of prompting for a username and password in the terminal.
If WEB_LOGIN
is set in .reviewboardrc
or the
--web
option is passed, rbt login will direct the user to
log in via the Review Board web page. Otherwise, the user will be prompted for
a username and password in the terminal. A session cookie will be saved in
.rbtools-cookies
upon successful authentication.
A username and password can also be directly supplied through the
--username
and --password
options.
Or, an API token can be used to log in with the --api-token
option.
Usage¶
$ rbt login [options]
Options¶
- -w, --web¶
Use web-based login instead of prompting for for credentials directly in the terminal.
The default can be set in
WEB_LOGIN
in .reviewboardrc.New in version 5.0.
- -o, --open¶
When using web-based login, this will automatically open a browser to the login page.
The default can be set in
OPEN_BROWSER
in .reviewboardrc.New in version 5.0.
- -l, --enable-logging¶
When using web-based login, this will display the login server logs. This should only be used by admins for debugging.
New in version 5.0.
- -d, --debug¶
Displays debug output.
This information can be valuable when debugging problems running the command.
The default can be set in
DEBUG
in .reviewboardrc.
- --json¶
Output results as JSON data instead of text.
The default can be set in
JSON_OUTPUT
in .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_URL
in .reviewboardrc.
- --username <username>¶
The user name to be supplied to the Review Board server.
The default can be set in
USERNAME
in .reviewboardrc.
- --password <password>¶
The password to be supplied to the Review Board server.
The default can be set in
PASSWORD
in .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_COOKIES
in .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_TOKEN
in .reviewboardrc.New in version 0.7.
- --disable-proxy¶
Prevents requests from going through a proxy server.
The default can be set in
ENABLE_PROXY
in .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_VERIFICATION
in .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_COOKIES
in .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_CACHE
in .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_CACHE
in .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_LOCATION
in .reviewboardrc.New in version 0.7.3.
- --ca-certs <file>¶
Additional TLS CA bundle.
The default can be set in
CA_CERTS
in .reviewboardrc.
- --client-key <file>¶
Key for TLS client authentication.
The default can be set in
CLIENT_KEY
in .reviewboardrc.
- --client-cert <file>¶
Certificate for TLS client authentication.
The default can be set in
CLIENT_CERT
in .reviewboardrc.
- --proxy-authorization <proxy authorization>¶
Value of the Proxy-Authorization header to send with HTTP requests.
The default can be set in
PROXY_AUTHORIZATION
in .reviewboardrc.