• Get Review Board
  • What's New
  • Products
  • Review Board Code review, image review, and document review
  • Documentation
  • Release Notes
  • Power Pack Enterprise integrations, reports, and enhanced document review
  • Try for 60 Days
  • Purchase
  • RBCommons Review Board as a Service, hosted by us
  • Pricing
  • RBTools Command line tools and Python API for Review Board
  • Documentation
  • Release Notes
  • Review Bot Automated code review, connecting tools you already use
  • Documentation
  • Release Notes
  • RB Gateway Manage Git and Mercurial repositories in your network
  • Documentation
  • Release Notes
  • Learn and Explore
  • What is Code Review?
  • Documentation
  • Frequently Asked Questions
  • Support Options
  • Third-Party Integrations
  • Demo
  • Review Board RBTools Power Pack Review Bot Djblets RB Gateway
    1. RBTools 1.0
    2. Version 5.x
    3. Version 4.x
    4. Version 3.x
    5. Version 2.0
    6. Version 1.0
    7. Version 0.7
    8. Version 0.6
    9. Version 0.5
  • Home
  • rbt
  • Configuration
  • Repository Configuration
  • Per-User Configuration
  • Team Foundation Server Configuration
  • Commands
  • alias
  • api-get
  • attach
  • clear-cache
  • close
  • diff
  • install
  • land
  • list-repo-types
  • login
  • logout
  • patch
  • post
  • publish
  • setup-completion
  • setup-repo
  • stamp
  • status
  • status-update
  • RBTools Python API
  • Overview of the Python API Client
  • Tutorial
  • Resource-Specific Functionality
  • RBTools Workflows
  • Using RBTools with Git
  • Glossary
  • General Index
  • Release Notes
  • This documentation covers RBTools 1.0. You can select a version above or view the latest documentation.

    General Index

    Symbols | C | D | E | G | P | R | T | U



    Symbols

    $RBTOOLS_CONFIG_PATH
    --all
    rbt-status command line option
    --api-token <token>
    rbt-api-get command line option
    rbt-attach command line option
    rbt-close command line option
    rbt-diff command line option
    rbt-land command line option
    rbt-login command line option
    rbt-logout command line option
    rbt-patch command line option
    rbt-post command line option
    rbt-publish command line option
    rbt-setup-repo command line option
    rbt-stamp command line option
    rbt-status command line option
    rbt-status-update command line option
    --basedir <path>
    rbt-diff command line option
    rbt-post command line option
    --branch <branch>
    rbt-post command line option
    --bugs-closed <bug id[,...]>
    rbt-post command line option
    --cache-location <file>
    rbt-api-get command line option
    rbt-attach command line option
    rbt-clear-cache command line option
    rbt-close command line option
    rbt-diff command line option
    rbt-land command line option
    rbt-login command line option
    rbt-logout command line option
    rbt-patch command line option
    rbt-post command line option
    rbt-publish command line option
    rbt-setup-repo command line option
    rbt-stamp command line option
    rbt-status command line option
    rbt-status-update command line option
    --caption
    rbt-attach command line option
    --change-id <id>
    rbt-status-update command line option
    --change-only
    rbt-post command line option
    --close-type
    rbt-close command line option
    --delete-branch
    rbt-land command line option
    --depends-on <id[,...]>
    rbt-post command line option
    --description
    rbt-close command line option
    --description <text>
    rbt-post command line option
    rbt-status-update command line option
    --description-file <filename>
    rbt-post command line option
    --dest
    rbt-land command line option
    --diff-filename <filename>
    rbt-diff command line option
    rbt-post command line option
    rbt-stamp command line option
    --diff-only
    rbt-post command line option
    --diff-revision <revision>
    rbt-patch command line option
    --disable-cache
    rbt-api-get command line option
    rbt-attach command line option
    rbt-close command line option
    rbt-diff command line option
    rbt-land command line option
    rbt-login command line option
    rbt-logout command line option
    rbt-patch command line option
    rbt-post command line option
    rbt-publish command line option
    rbt-setup-repo command line option
    rbt-stamp command line option
    rbt-status command line option
    rbt-status-update command line option
    --disable-cache-storage
    rbt-api-get command line option
    rbt-attach command line option
    rbt-close command line option
    rbt-diff command line option
    rbt-land command line option
    rbt-login command line option
    rbt-logout command line option
    rbt-patch command line option
    rbt-post command line option
    rbt-publish command line option
    rbt-setup-repo command line option
    rbt-stamp command line option
    rbt-status command line option
    rbt-status-update command line option
    --disable-cookie-storage
    rbt-api-get command line option
    rbt-attach command line option
    rbt-close command line option
    rbt-diff command line option
    rbt-land command line option
    rbt-login command line option
    rbt-logout command line option
    rbt-patch command line option
    rbt-post command line option
    rbt-publish command line option
    rbt-setup-repo command line option
    rbt-stamp command line option
    rbt-status command line option
    rbt-status-update command line option
    --disable-proxy
    rbt-api-get command line option
    rbt-attach command line option
    rbt-close command line option
    rbt-diff command line option
    rbt-land command line option
    rbt-login command line option
    rbt-logout command line option
    rbt-patch command line option
    rbt-post command line option
    rbt-publish command line option
    rbt-setup-repo command line option
    rbt-stamp command line option
    rbt-status command line option
    rbt-status-update command line option
    --disable-ssl-verification
    rbt-api-get command line option
    rbt-attach command line option
    rbt-close command line option
    rbt-diff command line option
    rbt-land command line option
    rbt-login command line option
    rbt-logout command line option
    rbt-patch command line option
    rbt-post command line option
    rbt-publish command line option
    rbt-setup-repo command line option
    rbt-stamp command line option
    rbt-status command line option
    rbt-status-update command line option
    --dry-run
    rbt-land command line option
    --dry-run <alias>
    rbt-alias command line option
    --ext-auth-cookies <ext auth cookies>
    rbt-api-get command line option
    rbt-attach command line option
    rbt-close command line option
    rbt-diff command line option
    rbt-land command line option
    rbt-login command line option
    rbt-logout command line option
    rbt-patch command line option
    rbt-post command line option
    rbt-publish command line option
    rbt-setup-repo command line option
    rbt-stamp command line option
    rbt-status command line option
    rbt-status-update command line option
    --filename
    rbt-attach command line option
    --guess-description <auto|yes|no>
    rbt-post command line option
    --guess-summary <auto|yes|no>
    rbt-post command line option
    --list
    rbt-alias command line option
    --local
    rbt-land command line option
    --markdown
    rbt-post command line option
    rbt-publish command line option
    --no-delete-branch
    rbt-land command line option
    --no-renames
    rbt-diff command line option
    rbt-post command line option
    rbt-stamp command line option
    --no-squash
    rbt-land command line option
    --p4-client <client name>
    rbt-diff command line option
    rbt-post command line option
    rbt-setup-repo command line option
    rbt-stamp command line option
    rbt-status command line option
    --p4-passwd <password>
    rbt-diff command line option
    rbt-post command line option
    rbt-setup-repo command line option
    rbt-stamp command line option
    rbt-status command line option
    --p4-port <port>
    rbt-diff command line option
    rbt-post command line option
    rbt-setup-repo command line option
    rbt-stamp command line option
    rbt-status command line option
    --parent <branch>
    rbt-diff command line option
    rbt-post command line option
    rbt-stamp command line option
    --password <password>
    rbt-api-get command line option
    rbt-attach command line option
    rbt-close command line option
    rbt-diff command line option
    rbt-land command line option
    rbt-login command line option
    rbt-logout command line option
    rbt-patch command line option
    rbt-post command line option
    rbt-publish command line option
    rbt-setup-repo command line option
    rbt-stamp command line option
    rbt-status command line option
    rbt-status-update command line option
    --pretty
    rbt-api-get command line option
    --print
    rbt-patch command line option
    --px <num>
    rbt-patch command line option
    --recursive
    rbt-land command line option
    --repository <name>
    rbt-attach command line option
    rbt-close command line option
    rbt-diff command line option
    rbt-land command line option
    rbt-patch command line option
    rbt-post command line option
    rbt-publish command line option
    rbt-stamp command line option
    rbt-status command line option
    --repository-type <type>
    rbt-attach command line option
    rbt-close command line option
    rbt-diff command line option
    rbt-land command line option
    rbt-patch command line option
    rbt-post command line option
    rbt-publish command line option
    rbt-stamp command line option
    rbt-status command line option
    --repository-url <url>
    rbt-attach command line option
    rbt-close command line option
    rbt-diff command line option
    rbt-land command line option
    rbt-patch command line option
    rbt-post command line option
    rbt-publish command line option
    rbt-stamp command line option
    rbt-status command line option
    --review <file path>
    rbt-status-update command line option
    --revision-range <rev1:rev2>
    rbt-diff command line option
    rbt-post command line option
    rbt-stamp command line option
    --server <url>
    rbt-api-get command line option
    rbt-attach command line option
    rbt-close command line option
    rbt-diff command line option
    rbt-land command line option
    rbt-login command line option
    rbt-logout command line option
    rbt-patch command line option
    rbt-post command line option
    rbt-publish command line option
    rbt-setup-repo command line option
    rbt-stamp command line option
    rbt-status command line option
    rbt-status-update command line option
    --service-id <service id>
    rbt-status-update command line option
    --squash
    rbt-land command line option
    --state <state>
    rbt-status-update command line option
    --submit-as <username>
    rbt-post command line option
    --summary <text>
    rbt-post command line option
    rbt-status-update command line option
    --svn-changelist <id>
    rbt-diff command line option
    rbt-post command line option
    --svn-password <password>
    rbt-diff command line option
    rbt-post command line option
    --svn-prompt-password
    rbt-diff command line option
    rbt-post command line option
    --svn-show-copies-as-adds <y|n>
    rbt-diff command line option
    rbt-post command line option
    --svn-username <username>
    rbt-diff command line option
    rbt-post command line option
    --target-groups <name[,...]>
    rbt-post command line option
    --target-people <username[,...]>
    rbt-post command line option
    --testing-done <text>
    rbt-post command line option
    --testing-done-file <filename>
    rbt-post command line option
    --tf-cmd <tf cmd>
    rbt-diff command line option
    rbt-post command line option
    rbt-setup-repo command line option
    rbt-status command line option
    --tfs-login <tfs login>
    rbt-diff command line option
    rbt-post command line option
    rbt-setup-repo command line option
    rbt-status command line option
    --tfs-shelveset-owner <tfs shelveset owner>
    rbt-diff command line option
    rbt-post command line option
    rbt-setup-repo command line option
    rbt-status command line option
    --timeout <timeout>
    rbt-status-update command line option
    --tracking-branch <branch>
    rbt-diff command line option
    rbt-land command line option
    rbt-post command line option
    rbt-stamp command line option
    --url <url>
    rbt-status-update command line option
    --url-text <url text>
    rbt-status-update command line option
    --username <username>
    rbt-api-get command line option
    rbt-attach command line option
    rbt-close command line option
    rbt-diff command line option
    rbt-land command line option
    rbt-login command line option
    rbt-logout command line option
    rbt-patch command line option
    rbt-post command line option
    rbt-publish command line option
    rbt-setup-repo command line option
    rbt-stamp command line option
    rbt-status command line option
    rbt-status-update command line option
    -c, --commit
    rbt-patch command line option
    -C, --commit-no-edit
    rbt-patch command line option
    -d, --debug
    rbt-alias command line option
    rbt-api-get command line option
    rbt-attach command line option
    rbt-clear-cache command line option
    rbt-close command line option
    rbt-diff command line option
    rbt-install command line option
    rbt-land command line option
    rbt-list-repo-types command line option
    rbt-login command line option
    rbt-logout command line option
    rbt-patch command line option
    rbt-post command line option
    rbt-publish command line option
    rbt-setup-completion command line option
    rbt-setup-repo command line option
    rbt-stamp command line option
    rbt-status command line option
    rbt-status-update command line option
    -e, --edit
    rbt-land command line option
    -f <field name=value>, --field <field name=value>
    rbt-post command line option
    -g [auto|yes|no], --guess-fields [auto|yes|no]
    rbt-post command line option
    -I <filename>, --include <filename>
    rbt-diff command line option
    rbt-post command line option
    rbt-stamp command line option
    -j, --json
    rbt-status-update command line option
    -m <text>, --change-description <text>
    rbt-post command line option
    -m, --change-description
    rbt-publish command line option
    -n, --no-push
    rbt-land command line option
    -o, --open
    rbt-post command line option
    -p, --publish
    rbt-post command line option
    -p, --push
    rbt-land command line option
    -r <id>, --review-request-id <id>
    rbt-land command line option
    rbt-post command line option
    rbt-stamp command line option
    rbt-status-update command line option
    -R, --revert
    rbt-patch command line option
    -s <id>, --status-update-id <id>
    rbt-status-update command line option
    -s, --stamp
    rbt-post command line option
    -t, --trivial
    rbt-publish command line option
    -t, --trivial-publish
    rbt-post command line option
    -u, --update
    rbt-post command line option
    -X <pattern>, --exclude <pattern>
    rbt-diff command line option
    rbt-post command line option
    rbt-stamp command line option


    C

    context diff


    D

    diff file


    E

    environment variable
    $RBTOOLS_CONFIG_PATH
    EDITOR
    RBTOOLS_CONFIG_PATH
    RBTOOLS_EDITOR , [Link]
    VISUAL


    G

    get_diff_data() (FileDiffResource method)
    get_or_create_draft() (ReviewRequestResource method)
    get_patch() (DiffResource method)
    (FileDiffResource method)


    P

    parent diffs
    post-commit hook
    post-commit review
    pre-commit review
    private review requests


    R

    rbt alias
    RBTools command
    rbt api-get
    RBTools command
    rbt attach
    RBTools command
    rbt clear-cache
    RBTools command
    rbt close
    RBTools command
    rbt diff
    RBTools command
    rbt install
    RBTools command
    rbt land
    RBTools command
    rbt list-repo-types
    RBTools command
    rbt login
    RBTools command
    rbt logout
    RBTools command
    rbt patch
    RBTools command
    rbt post
    RBTools command
    rbt publish
    RBTools command
    rbt setup-completion
    RBTools command
    rbt setup-repo
    RBTools command
    rbt stamp
    RBTools command
    rbt status
    RBTools command
    rbt status-update
    RBTools command
    rbt-alias command line option
    --dry-run <alias>
    --list
    -d, --debug
    rbt-api-get command line option
    --api-token <token>
    --cache-location <file>
    --disable-cache
    --disable-cache-storage
    --disable-cookie-storage
    --disable-proxy
    --disable-ssl-verification
    --ext-auth-cookies <ext auth cookies>
    --password <password>
    --pretty
    --server <url>
    --username <username>
    -d, --debug
    rbt-attach command line option
    --api-token <token>
    --cache-location <file>
    --caption
    --disable-cache
    --disable-cache-storage
    --disable-cookie-storage
    --disable-proxy
    --disable-ssl-verification
    --ext-auth-cookies <ext auth cookies>
    --filename
    --password <password>
    --repository <name>
    --repository-type <type>
    --repository-url <url>
    --server <url>
    --username <username>
    -d, --debug
    rbt-clear-cache command line option
    --cache-location <file>
    -d, --debug
    rbt-close command line option
    --api-token <token>
    --cache-location <file>
    --close-type
    --description
    --disable-cache
    --disable-cache-storage
    --disable-cookie-storage
    --disable-proxy
    --disable-ssl-verification
    --ext-auth-cookies <ext auth cookies>
    --password <password>
    --repository <name>
    --repository-type <type>
    --repository-url <url>
    --server <url>
    --username <username>
    -d, --debug
    rbt-diff command line option
    --api-token <token>
    --basedir <path>
    --cache-location <file>
    --diff-filename <filename>
    --disable-cache
    --disable-cache-storage
    --disable-cookie-storage
    --disable-proxy
    --disable-ssl-verification
    --ext-auth-cookies <ext auth cookies>
    --no-renames
    --p4-client <client name>
    --p4-passwd <password>
    --p4-port <port>
    --parent <branch>
    --password <password>
    --repository <name>
    --repository-type <type>
    --repository-url <url>
    --revision-range <rev1:rev2>
    --server <url>
    --svn-changelist <id>
    --svn-password <password>
    --svn-prompt-password
    --svn-show-copies-as-adds <y|n>
    --svn-username <username>
    --tf-cmd <tf cmd>
    --tfs-login <tfs login>
    --tfs-shelveset-owner <tfs shelveset owner>
    --tracking-branch <branch>
    --username <username>
    -I <filename>, --include <filename>
    -X <pattern>, --exclude <pattern>
    -d, --debug
    rbt-install command line option
    -d, --debug
    rbt-land command line option
    --api-token <token>
    --cache-location <file>
    --delete-branch
    --dest
    --disable-cache
    --disable-cache-storage
    --disable-cookie-storage
    --disable-proxy
    --disable-ssl-verification
    --dry-run
    --ext-auth-cookies <ext auth cookies>
    --local
    --no-delete-branch
    --no-squash
    --password <password>
    --recursive
    --repository <name>
    --repository-type <type>
    --repository-url <url>
    --server <url>
    --squash
    --tracking-branch <branch>
    --username <username>
    -d, --debug
    -e, --edit
    -n, --no-push
    -p, --push
    -r <id>, --review-request-id <id>
    rbt-list-repo-types command line option
    -d, --debug
    rbt-login command line option
    --api-token <token>
    --cache-location <file>
    --disable-cache
    --disable-cache-storage
    --disable-cookie-storage
    --disable-proxy
    --disable-ssl-verification
    --ext-auth-cookies <ext auth cookies>
    --password <password>
    --server <url>
    --username <username>
    -d, --debug
    rbt-logout command line option
    --api-token <token>
    --cache-location <file>
    --disable-cache
    --disable-cache-storage
    --disable-cookie-storage
    --disable-proxy
    --disable-ssl-verification
    --ext-auth-cookies <ext auth cookies>
    --password <password>
    --server <url>
    --username <username>
    -d, --debug
    rbt-patch command line option
    --api-token <token>
    --cache-location <file>
    --diff-revision <revision>
    --disable-cache
    --disable-cache-storage
    --disable-cookie-storage
    --disable-proxy
    --disable-ssl-verification
    --ext-auth-cookies <ext auth cookies>
    --password <password>
    --print
    --px <num>
    --repository <name>
    --repository-type <type>
    --repository-url <url>
    --server <url>
    --username <username>
    -C, --commit-no-edit
    -R, --revert
    -c, --commit
    -d, --debug
    rbt-post command line option
    --api-token <token>
    --basedir <path>
    --branch <branch>
    --bugs-closed <bug id[,...]>
    --cache-location <file>
    --change-only
    --depends-on <id[,...]>
    --description <text>
    --description-file <filename>
    --diff-filename <filename>
    --diff-only
    --disable-cache
    --disable-cache-storage
    --disable-cookie-storage
    --disable-proxy
    --disable-ssl-verification
    --ext-auth-cookies <ext auth cookies>
    --guess-description <auto|yes|no>
    --guess-summary <auto|yes|no>
    --markdown
    --no-renames
    --p4-client <client name>
    --p4-passwd <password>
    --p4-port <port>
    --parent <branch>
    --password <password>
    --repository <name>
    --repository-type <type>
    --repository-url <url>
    --revision-range <rev1:rev2>
    --server <url>
    --submit-as <username>
    --summary <text>
    --svn-changelist <id>
    --svn-password <password>
    --svn-prompt-password
    --svn-show-copies-as-adds <y|n>
    --svn-username <username>
    --target-groups <name[,...]>
    --target-people <username[,...]>
    --testing-done <text>
    --testing-done-file <filename>
    --tf-cmd <tf cmd>
    --tfs-login <tfs login>
    --tfs-shelveset-owner <tfs shelveset owner>
    --tracking-branch <branch>
    --username <username>
    -I <filename>, --include <filename>
    -X <pattern>, --exclude <pattern>
    -d, --debug
    -f <field name=value>, --field <field name=value>
    -g [auto|yes|no], --guess-fields [auto|yes|no]
    -m <text>, --change-description <text>
    -o, --open
    -p, --publish
    -r <id>, --review-request-id <id>
    -s, --stamp
    -t, --trivial-publish
    -u, --update
    rbt-publish command line option
    --api-token <token>
    --cache-location <file>
    --disable-cache
    --disable-cache-storage
    --disable-cookie-storage
    --disable-proxy
    --disable-ssl-verification
    --ext-auth-cookies <ext auth cookies>
    --markdown
    --password <password>
    --repository <name>
    --repository-type <type>
    --repository-url <url>
    --server <url>
    --username <username>
    -d, --debug
    -m, --change-description
    -t, --trivial
    rbt-setup-completion command line option
    -d, --debug
    rbt-setup-repo command line option
    --api-token <token>
    --cache-location <file>
    --disable-cache
    --disable-cache-storage
    --disable-cookie-storage
    --disable-proxy
    --disable-ssl-verification
    --ext-auth-cookies <ext auth cookies>
    --p4-client <client name>
    --p4-passwd <password>
    --p4-port <port>
    --password <password>
    --server <url>
    --tf-cmd <tf cmd>
    --tfs-login <tfs login>
    --tfs-shelveset-owner <tfs shelveset owner>
    --username <username>
    -d, --debug
    rbt-stamp command line option
    --api-token <token>
    --cache-location <file>
    --diff-filename <filename>
    --disable-cache
    --disable-cache-storage
    --disable-cookie-storage
    --disable-proxy
    --disable-ssl-verification
    --ext-auth-cookies <ext auth cookies>
    --no-renames
    --p4-client <client name>
    --p4-passwd <password>
    --p4-port <port>
    --parent <branch>
    --password <password>
    --repository <name>
    --repository-type <type>
    --repository-url <url>
    --revision-range <rev1:rev2>
    --server <url>
    --tracking-branch <branch>
    --username <username>
    -I <filename>, --include <filename>
    -X <pattern>, --exclude <pattern>
    -d, --debug
    -r <id>, --review-request-id <id>
    rbt-status command line option
    --all
    --api-token <token>
    --cache-location <file>
    --disable-cache
    --disable-cache-storage
    --disable-cookie-storage
    --disable-proxy
    --disable-ssl-verification
    --ext-auth-cookies <ext auth cookies>
    --p4-client <client name>
    --p4-passwd <password>
    --p4-port <port>
    --password <password>
    --repository <name>
    --repository-type <type>
    --repository-url <url>
    --server <url>
    --tf-cmd <tf cmd>
    --tfs-login <tfs login>
    --tfs-shelveset-owner <tfs shelveset owner>
    --username <username>
    -d, --debug
    rbt-status-update command line option
    --api-token <token>
    --cache-location <file>
    --change-id <id>
    --description <text>
    --disable-cache
    --disable-cache-storage
    --disable-cookie-storage
    --disable-proxy
    --disable-ssl-verification
    --ext-auth-cookies <ext auth cookies>
    --password <password>
    --review <file path>
    --server <url>
    --service-id <service id>
    --state <state>
    --summary <text>
    --timeout <timeout>
    --url <url>
    --url-text <url text>
    --username <username>
    -d, --debug
    -j, --json
    -r <id>, --review-request-id <id>
    -s <id>, --status-update-id <id>
    RBTools command
    rbt alias
    rbt api-get
    rbt attach
    rbt clear-cache
    rbt close
    rbt diff
    rbt install
    rbt land
    rbt list-repo-types
    rbt login
    rbt logout
    rbt patch
    rbt post
    rbt publish
    rbt setup-completion
    rbt setup-repo
    rbt stamp
    rbt status
    rbt status-update
    RBTOOLS_EDITOR


    T

    topological sort


    U

    unified diff
    upload_attachment() (DraftFileAttachmentListResource method)
    (DraftScreenshotListResource method)
    (FileAttachmentListResource method)
    (ScreenshotListResource method)
    upload_diff() (DiffListResource method)

    Keep up with the latest Review Board releases, security updates, and helpful information.

    About
    News
    Demo
    RBCommons Hosting
    Integrations
    Happy Users
    Support Options
    Documentation
    FAQ
    User Manual
    RBTools
    Administration Guide
    Power Pack
    Release Notes
    Downloads
    Review Board
    RBTools
    Djblets
    Power Pack
    Package Store
    PGP Signatures
    Contributing
    Bug Tracker
    Submit Patches
    Development Setup
    Wiki
    Follow Us
    Mailing Lists
    Reddit
    Twitter
    Mastodon
    Facebook
    YouTube

    Copyright © 2006-2025 Beanbag, Inc. All rights reserved.

    Terms of Service — Privacy Policy — AI Ethics Policy — Branding

    On this page

    • [Top]