Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add aqua installation method #451

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+17 −2
Open

docs: add aqua installation method #451

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
19 changes: 17 additions & 2 deletions site/content/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,21 @@ asdf install mage latest
asdf global mage latest
```

### Using Aqua

aqua is a declarative CLI Version Manager written in Go.
You can install CLI tools and manage their versions with YAML declaratively.

To add to a project tool config:

```shell
aqua init
aqua generate -i mage
aqua install
```

To add to a global `aqua.yaml`, add to the [global configuration](https://aquaproj.github.io/docs/tutorial-basics/global-config) and finally run `aqua install --all` for Mage to be installed.

## Example Magefile

```go
Expand All @@ -97,7 +112,7 @@ Run the above `Build` target by simply running `mage build` in the same director

## Magefiles directory

If you create your Magefile or files within a directory named `magefiles` And there is no Magefile in your current directory,
If you create your Magefile or files within a directory named `magefiles` And there is no Magefile in your current directory,
`mage` will default to the directory as the source for your targets while keeping the current directory as working one.

The result is the equivalent of running `mage -d magefiles -w .`
Expand Down Expand Up @@ -133,7 +148,7 @@ Commands:
-version show version info for the mage binary

Options:
-d <string>
-d <string>
directory to read magefiles from (default ".")
-debug turn on debug messages
-f force recreation of compiled magefile
Expand Down