Skip to content

Installing the CLI

The bosh CLI is the command line tool used for interacting with all things BOSH, from deployment operations to software release management.

Install

Choose your preferred installation method below to get the latest version of bosh.

Using the binary directly

To install the bosh binary directly:

  1. Navigate to the BOSH CLI GitHub release page and choose the correct download for your operating system.

  2. Make the bosh binary executable and move the binary to your PATH:

    $ chmod +x ./bosh
    $ sudo mv ./bosh /usr/local/bin/bosh
    
  3. You should now be able to use bosh. Verify by querying the CLI for its version:

    $ bosh -v
    version 5.3.1-8366c6fd-2018-09-25T18:25:51Z
    
    Succeeded
    

Using Homebrew on macOS

If you are on macOS with Homebrew, you can install using the Cloud Foundry tap.

  1. Use brew to install bosh-cli:

    $ brew install cloudfoundry/tap/bosh-cli
    
  2. You should now be able to use bosh. Verify by querying the CLI for its version:

    $ bosh -v
    version 5.3.1-8366c6fd-2018-09-25T18:25:51Z
    
    Succeeded
    

Note

We currently do not publish BOSH CLI via apt or yum repositories.

Additional Dependencies

When you are using bosh to bootstrap BOSH or other standalone VMs, you will need a few extra dependencies installed on your local system.

Tip

If you will not be using create-env and delete-env commands, you can skip this section.

Ubuntu Trusty

If you are running on Ubuntu Trusty, ensure the following packages are installed on your system:

$ sudo apt-get install -y build-essential zlibc zlib1g-dev ruby ruby-dev openssl libxslt-dev libxml2-dev libssl-dev libreadline6 libreadline6-dev libyaml-dev libsqlite3-dev sqlite3

macOS

  1. Install the Apple Command Line Tools:

    $ xcode-select --install
    
  2. Use Homebrew to additionally install OpenSSL:

    $ brew install openssl
    

CentOS

If you are running on CentOS, ensure the following packages are installed on your system:

$ sudo yum install gcc gcc-c++ ruby ruby-devel mysql-devel postgresql-devel postgresql-libs sqlite-devel libxslt-devel libxml2-devel patch openssl
$ gem install yajl-ruby

Windows

The create-env and destroy-env commands are not yet supported on native Windows. Feel free to give it a try (and let us know if you have feedback), but we would recommend leveraging the Windows Subsystem for Linux if you need to run either command.

Other

You should be able to use bosh on other systems... we just don't know the exact packages to recommend. In general, use these recommendations (and send us a pull request to update this page once you figure it out!):

  • compilation tools (often a build-essential-like package or "Development Tools"-like group)
  • Ruby v2.4+