From 2fdecc045fdb509832a758e45412c115fa03e8e8 Mon Sep 17 00:00:00 2001 From: Sam Alba Date: Mon, 3 May 2021 17:21:47 -0700 Subject: [PATCH] docs: install instructions Signed-off-by: Sam Alba --- doc/install.md | 53 ++++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 45 insertions(+), 8 deletions(-) diff --git a/doc/install.md b/doc/install.md index fe16442e..5f245931 100644 --- a/doc/install.md +++ b/doc/install.md @@ -1,16 +1,53 @@ # Installing Dagger -1. Build the `dagger` command-line tool. You will need [Go](https://golang.org) version 1.16 or later. +## Option 1 (Mac OS only): install from Homebrew -``` -$ make +From your Mac OS terminal, run the following command: + +```shell +brew install dagger/tap/dagger ``` -2. Copy the `dagger` tool to a location listed in your `$PATH`. For example, to copy it to `/usr/local/bin`: +## Option 2: install from a shell script -``` -$ cp ./cmd/dagger/dagger /usr/local/bin +From a terminal, run the following command: + +```shell +curl -sfL https://dagger-io.s3.amazonaws.com/dagger/install.sh | sh ``` -3. Make sure your machine is running a buildkit daemon. If you have Docker installed, you're already good to go. -Otherwise, install either [Docker](https://www.docker.com/products/docker-desktop) or [buildkit](https://github.com/moby/buildkit#quick-start). +You now have the dagger binary in the local directory under `./bin/dagger`. + +You can then install it globally on your system: + +```shell +sudo mv ./bin/dagger /usr/local/bin +``` + +## Option 3: Manually fetch the latest binary release from Github + +Open your web browser to [the latest release](https://github.com/dagger/dagger/releases/latest). + +From the **assets** section, download the archive corresponding to your OS and Arch. + +## Option 4: Compile from source + +You will need [Go](https://golang.org) version 1.16 or later. + +1. Clone the dagger repository + +```shell +git clone https://github.com/dagger/dagger.git +``` + +2. Build the `dagger` binary. + +```shell +cd dagger; make +``` + +3. Copy the `dagger` tool to a location listed in your `$PATH`. For example, to copy it to `/usr/local/bin`: + +```shell +cp ./cmd/dagger/dagger /usr/local/bin +```