• 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 2.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
    10. rbt
    11. Commands
    12. setup-completion
  • 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 2.0. You can select a version above or view the latest documentation.

    setup-completion¶

    New in version 1.0.

    rbt setup-completion currently supports Bash and Zsh for auto-completions. The command will detect your login shell and install the appropriate auto-completions for your shell. You can also specify which auto-completions you wish to install by replacing <shell> with either bash or zsh.

    Usage¶

    $ rbt setup-completion [options] <shell>
    

    Please refer to the installation notes for OS X and Linux if you are having difficulties running the command.

    Installation Notes¶

    OS X¶

    Zsh gets installed in a directory that requires root permission to write to. You can either run the command as root or follow the instructions for manual installation below. To install, run:

    $ sudo rbt setup-completion zsh
    

    Note: Bash on OS X does not require the use of sudo.

    Linux¶

    Both Bash and Zsh are installed in directories that require root permission to write to. You can either run the command as root or follow the instructions for manual installation below. To install, run:

    $ sudo rbt setup-completion <shell>
    

    Manual Installation¶

    Bash¶

    You will first need to download the bash auto completion file. Copy the file to your home directory, and add the following command to your .bash_profile file:

    source ~/rbt-bash-completion
    

    ZSH¶

    You will first need to download the zsh auto completion file. Next, create a directory in your home directory called .rbt-completion and copy the file to ~/.rbt-completion. Then add the following to your .zshrc file:

    fpath=(~/.rbt-completion $fpath)
    autoload -U compinit && compinit
    

    Options¶

    -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.

    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]
    • Usage
    • Installation Notes
      • OS X
      • Linux
    • Manual Installation
      • Bash
      • ZSH
    • Options