kjuulh/dagger
Archived
1
0
Fork 0
Code Issues 1 Pull Requests 1 Projects Releases Wiki Activity

Update documentation

Browse Source 
Signed-off-by: Tom Chauveau <tom.chauveau@epitech.eu>
This commit is contained in:
Tom Chauveau
2021-05-06 19:20:56 +02:00
parent 5f723df36a
commit 0e320eca70
3 changed files with 86 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
doc/install.md
View File

@@ -1,5 +1,11 @@
# Installing Dagger
## Summary
- [Option 1 (Mac OS only): install from Homebrew](#option-1--mac-os-only---install-from-homebrew)
- [Option 2: install from a shell script](#option-2--install-from-a-shell-script)
- [Option 3: Manually fetch the latest binary release from Github](#option-3--manually-fetch-the-latest-binary-release-from-github)
- [Option 4: Compile from source](#option-4--compile-from-source)
## Option 1 (Mac OS only): install from Homebrew
From your Mac OS terminal, run the following command:
@@ -8,12 +14,14 @@ From your Mac OS terminal, run the following command:
brew install dagger/tap/dagger
```
> :bulb: Verify the installation with `dagger version`.
## Option 2: install from a shell script
From a terminal, run the following command:
```shell
curl -sfL https://dagger-io.s3.amazonaws.com/dagger/install.sh | sh
curl -sfL https://releases.dagger.io/dagger/install.sh | sh
```
You now have the dagger binary in the local directory under `./bin/dagger`.
@@ -24,12 +32,16 @@ You can then install it globally on your system:
sudo mv ./bin/dagger /usr/local/bin
```
> :bulb: Verify the installation with `dagger version`.
## 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.
> :bulb: Verify the installation with `dagger version`.
## Option 4: Compile from source
You will need [Go](https://golang.org) version 1.16 or later.
@@ -51,3 +63,5 @@ cd dagger; make
```shell
cp ./cmd/dagger/dagger /usr/local/bin
```
> :bulb: Verify the installation with `dagger version`.

67
doc/update.md Normal file
View File

@@ -0,0 +1,67 @@
# Updating Dagger
## Summary
- [Option 1: (Mac OS only): update from Homebrew](#option-1--mac-os-only---update-from-homebrew)
- [Option 2: update from a shell script](#option-2--update-from-a-shell-script)
- [Option 3: Manually fetch the latest binary release from Github](#option-3--manually-fetch-the-latest-binary-release-from-github)
- [Option 4: Compile from source](#option-4--compile-from-source)
## Option 1: (Mac OS only): update from Homebrew
From your Mac OS terminal, run the following command:
```shell
brew update dagger/tap/dagger
```
> :bulb: Verify the update with `dagger version`.
## Option 2: update from 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 update it globally on your system:
```shell
sudo mv ./bin/dagger /usr/local/bin
```
> :bulb: Verify the update with `dagger version`.
## 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.
> :bulb: Verify the update with `dagger version`.
## 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
```
> :bulb: Verify the update with `dagger version`.