This repository has been archived on 2024-04-08. You can view files and clone it, but cannot push or open issues or pull requests.
dagger/docs/1001-install.md
Benjamin Reigner 900f23215e
fix: Build from source instructions
The build from source instructions were deprecated since it prints the
available make targets when running `make` whereas, before it built
dagger in dev mode.
Now to build dagger in dev mode, you have to run `make dagger`.
The doc is now up to date with this.

Signed-off-by: Benjamin Reigner <benjamin.reigner@epitech.eu>
2022-01-28 11:38:04 +01:00

99 lines
2.2 KiB
Markdown

---
slug: /1001/install/
---
# Install Dagger
:::caution Requirement
- Dagger requires [Docker](https://docs.docker.com/get-docker/) to be installed and running.
:::
## Option 1: Use Homebrew (Mac OS only)
From your Mac OS terminal, run the following command:
```shell
brew install dagger/tap/dagger
```
If dagger is already installed, you can upgrade it using this command:
```shell
brew update
brew upgrade dagger
```
## Option 2: Run a shell script
From a terminal, run the following command:
```shell
curl -sfL https://releases.dagger.io/dagger/install.sh | sh
```
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 2 (Windows): Run a shell script
From a terminal, run the following command:
```shell
curl https://releases.dagger.io/dagger/install.ps1 -OutFile install.ps1 ; ./install.ps1; rm install.ps1
```
We try to move the dagger binary under `C:\Windows\System32` but
in case use missing the necessary permission we'll save everything under `<your home folder>/dagger`
## Option 3: Download a binary release
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: Install 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 dagger
```
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
```
## Enable autocompletion manually
You can generate an auto completion script using `dagger completion <your shell>`
```sh
Usage:
dagger completion [command]
Available Commands:
bash generate the autocompletion script for bash
fish generate the autocompletion script for fish
powershell generate the autocompletion script for powershell
zsh generate the autocompletion script for zsh
```
Use `dagger completion <your shell> --help` for shell specific instructions.