HashiCorp Developer AI Private beta now available Sign up today
Boundary
Self-managed quick start

Install the Boundary CLI

  • 6min
  • |
  • Boundary

To get started, install the Boundary command-line interface (CLI) in your development environment. Boundary is available as source code, as a pre-compiled binary, or in packaged formats.

This tutorial will not cover how to compile Boundary from source, but compiling from source is covered in the README for those who want to be sure they're compiling source they trust into the final binary.

The macOS binary can be installed manually or through Homebrew.

To install Boundary, find the appropriate package for your system and download it. Boundary is packaged as a zip archive.

After downloading Boundary, unzip the package. Boundary runs as a single binary named boundary. Make sure that the boundary binary is available on your PATH. You can check the locations available on your path by running this command.

$ echo $PATH

Example output:

/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin

The output is a list of locations separated by colons. You can make Boundary available by moving the binary to one of the listed locations, or by adding Boundary's location to your PATH.

Tip

Permanently add a new location to your path by editing your shell's settings file (usually called something like ~/.bashrc, where the part of the file name after the . and before rc is the name of your shell). In that file you will see a line that starts with export PATH=, followed by a colon-separated list of locations. Add the location of the Boundary binary to that list and save the file. Then reload your shell's configuration with the command source ~/.bashrc, replacing bash with the name of your shell.

Verify the installation

After installing Boundary, verify the installation worked by opening a new command prompt or console, and checking that boundary is available.

Tip

If you receive an error that Boundary is not found, try logging out and logging back in to your system (particularly necessary sometimes for Windows).

$ boundary
Usage: boundary <command> [args]

Local/Client Commands:
    authenticate      Authenticate the local client
    config            Manage the local client's configuration
    connect           Connect to a target through a Boundary worker
    daemon            Manages the client side Boundary cache daemon
    dev               Start a Boundary dev environment
    logout            Delete the current token within Boundary and forget it locally
    search            Search Boundary resources using client side cache
    server            Start a Boundary server

Generic Commands:
    delete      Run a generic delete command against a resource
    read        Run a generic read command against a resource
    update      Run a generic update command against a resource

Type-Specific Commands:
    accounts                  Manage Boundary accounts
    aliases                   Manage Boundary aliases
    auth-methods              Manage Boundary auth methods
    auth-tokens               Manage Boundary auth tokens
    billing                   Manage Boundary billing
    credential-libraries      Manage Boundary credential libraries
    credential-stores         Manage Boundary credential stores
    credentials               Manage Boundary credentials
    database                  Manage Boundary's database
    groups                    Manage Boundary groups
    host-catalogs             Manage Boundary host catalogs
    host-sets                 Manage Boundary unknowns
    hosts                     Manage Boundary hosts
    managed-groups            Manage Boundary managed groups
    policies                  Manage Boundary policies
    roles                     Manage Boundary roles
    scopes                    Manage Boundary scopes
    session-recordings        Manage Boundary session recordings
    sessions                  Manage Boundary sessions
    storage-buckets           Manage Boundary storage buckets
    targets                   Manage Boundary targets
    users                     Manage Boundary users
    workers                   Manage Boundary workers

You have successfully downloaded and installed Boundary! Continue to the next tutorial to set up your first Boundary project.

Next steps

You installed Boundary Community Edition to your local dev environment. Next you will Start a devolopment environment.

Previous

Introduction to Boundary Community Edition

 Next

Start a development environment