Install CockroachDB on Mac

Download the binary

1. Download the CockroachDB archive for OS X, and extract the binary:

   $ curl https://binaries.cockroachdb.com/cockroach-v20.1.17.darwin-10.9-amd64.tgz | tar -xz

2. Copy the binary into your PATH so you can execute cockroach commands from any shell:

   cp -i cockroach-v20.1.17.darwin-10.9-amd64/cockroach /usr/local/bin/

   If you get a permissions error, prefix the command with sudo.

3. Keep up-to-date with CockroachDB releases and best practices:

   Thanks!

Use Kubernetes

To orchestrate CockroachDB locally using Kubernetes, either with configuration files or the Helm package manager, see Orchestrate CockroachDB Locally with Minikube.

Use Docker

1. Install Docker for Mac. Please carefully check that you meet all prerequisites.

2. Confirm that the Docker daemon is running in the background:

   $ docker version

   If you do not see the server listed, start the Docker daemon.

3. Pull the image for the v20.1.17 release of CockroachDB from Docker Hub:

   $ docker pull cockroachdb/cockroach:v20.1.17

4. Keep up-to-date with CockroachDB releases and best practices:

   Thanks!

Build from source

1. Install the following prerequisites, as necessary:

   C++ compiler	Must support C++ 11. GCC prior to 6.0 does not work due to this issue. On macOS, Xcode should suffice.
   Go	Version 1.13.5+ is required, but 1.14 and above is not recommended. Older versions might work via make build IGNORE_GOVERS=1.
   Bash	Versions 4+ are preferred, but later releases from the 3.x series are also known to work.
   CMake	Versions 3.8+ are known to work.
   Autoconf	Version 2.68 or higher is required.

   A 64-bit system is strongly recommended. Building or running CockroachDB on 32-bit systems has not been tested. You'll also need at least 2GB of RAM. If you plan to run our test suite, you'll need closer to 4GB of RAM.

2. Download the CockroachDB v20.1.17 source archive, and extract the sources:

   $ curl https://binaries.cockroachdb.com/cockroach-v20.1.17.src.tgz | tar -xz

3. In the extracted directory, run make build:

   cd cockroach-v20.1.17

   make build

   The build process can take 10+ minutes, so please be patient.

4. Install the cockroach binary into /usr/local/bin/ so it's easy to execute cockroach commands from any directory:

   make install

   If you get a permissions error, prefix the command with sudo.

   You can also execute the cockroach binary directly from its built location, ./src/github.com/cockroachdb/cockroach/cockroach, but the rest of the documentation assumes you have the binary on your PATH.

5. Keep up-to-date with CockroachDB releases and best practices:

   Thanks!