Installing Habitat

Below you'll find installation instructions for each platform and their requirements. The Habitat CLI is currently supported on Linux, Mac, and Windows.

Table of Contents

Download and Install the Habitat CLI Tool

From building packages to running services, everything in Habitat is done through the hab command-line interface (CLI) tool. To get started using Habitat, you need to download and install the hab CLI tool that corresponds to your workstation OS.


Habitat for Linux

Habitat for Linux requires a 64-bit processor with kernel 2.6.32 or later. On Linux, exporting your Habitat artifact to a Docker image requires the Docker Engine supplied by Docker. Packages from distribution-specific or otherwise alternative providers are currently not supported.

Once you have downloaded the package, extract the hab binary with tar to /usr/local/bin or add its location to your PATH (e.g. tar -xvzf hab.tgz -C /usr/local/bin --strip-components 1).

Download Habitat for Linux

Install Habitat from the Command Line

Alternatively, you can install Habitat via the command line by downloading and running the installation script:

curl https://raw.githubusercontent.com/habitat-sh/habitat/master/components/hab/install.sh | sudo bash

Habitat for Mac

Requires 64-bit processor running 10.9 or later

Once you have downloaded the hab CLI, unzip it onto your machine. Unzipping to /usr/local/bin should place it on your PATH. In order to use the Habitat Studio, you'll also need to install Docker for Mac.

Download Habitat for MacDownload Docker for Mac

Install Habitat Using Homebrew

Habitat can also be installed with Homebrew, by running the following commands:

$ brew tap habitat-sh/habitat
$ brew install hab

Habitat for Windows

Requires 64-bit Windows 10 Pro, Enterprise, or Education editions (1511 November update, build 10586 or later) with Hyper-V enabled

Once you have downloaded the hab CLI, unzip it onto your machine. We suggest unzipping to C:\habitat and then adding that folder to your PATH variable. Here’s how to do that with Powershell:

$ $env:PATH += ";C:\habitat"

In order to use the Habitat Studio, you'll also need to install Docker for Windows.

Download Habitat for WindowsDownload Docker for Windows

Installing Habitat on Windows Using Chocolatey

Habitat can also be installed with Chocolatey, by running the following command:

$ choco install habitat

Configure Your Workstation

Once Habitat has been installed, the hab CLI makes it easy to get your workstation configured by guiding through the setup process. To set up your workstation, run hab cli setup and follow the instructions.

screenshot of hab cli setup output in CLI

Setup asks you to create a new origin and a set of origin keys.

Optionally, you can also provide a Habitat personal access token to upload packages to the public depot and share them with the Habitat community. See the access token documentation for details on generating and using your access token.

For more information about using Habitat Builder, see the section on Working with Builder.

You will also be asked if you want to register Supervisor control gateway secret (see Remote Command-and-Control of Supervisors for further details).

During setup, you may elect to provide anonymous usage data of the hab CLI tool. This information is used by the Habitat team to improve the CLI experience. For information on the types of data we gather and how we intend to use it, see Analytics in Habitat.

You can change your settings at any time by re-running the hab cli setup command.

screenshot of completed hab cli setup in CLI

That's it. You're all set up and ready to use Habitat to build and run packages!


Download and Install FAQ

This section tracks some questions that are frequently encountered when downloading and installing the hab binary.

Q: Can I just download a GitHub release of Habitat?

A: While we do cut releases in GitHub as part of our release process those archives are going to be a tar'ed point in time of our source code. As the hab cli is written in Rust, if you follow this approach you'll need to compile the source for your platform.

Q: Compile for my platform? Does that mean there aren't any OS native packages of hab?

A: We publish compiled packages for OSX, Linux, and Windows. hab has a requirement of either a Linux kernel >= 2.6.32, OSX >= 10.9, or 64-bit Windows 10 Pro, Enterprise, or Education editions (1511 November update, build 10586 or later) with Hyper-V enabled.

Q: What if I need an old version of hab?

A: We've got you covered! The script we provide for doing curlbash installations will allow you to specify a -v flag to pull down a specific version of Habitat.

Q: Oh! A curlbash I (love||hate) those.

A: Indeed they are divisive, we know, that's why we provide a few different ways for you to download. If you'd like to take a look at the script before running it, you can find it in the core habitat repo.

If you're staunchly in the anti-curlbash camp, you can get the latest packages from the download links listed previously, or via releases on our Bintray page.

Q: How do I install hab across my server fleet?

A: For the most part, we leave that up to you. You could just use the aforementioned curl-bash with your provisioner of choice. If your app was dockerized with Habitat then you won't even need to ask this question, because you'll have everything you need inside your container. We are working on first class Mesosphere DC/OS, Cloud Foundry, and Kubernetes integrations - which you can keep up to date on in our best practices section and blog.