aqua
Aqua Overview🔗
A cli version manager for the discriminating cli connoisseur, this tool is great to install binaries both at global level and project level.
If you are using asdf, I highly recommend this as an alternative, with the caveat of it not managing python, ruby, or other runtimes.
It's focused on cli development tools, and providing a global or project level version configuration that automatically installs on demand.
Aqua runs as a proxy for the invoked cli's, which means it automatically handles installing the called tool if it's missing on demand, further cutting down initial setup time.
You can even use in docker images or CI and have a single version pinned file helping the local and CI tools be similar.
It's more secure than asdf by default.
Quick Start🔗
Quick Start includes install commands to setup.
I use curl based install mostly: Install
Update Your Path🔗
export PATH="${AQUA_ROOT_DIR:-${XDG_DATA_HOME:-$HOME/.local/share}/aquaproj-aqua}/bin:$PATH"
The options below are one for max flexibility in honoring the XDG_Directory standard, the other just assumes .local.
$ENV:XDG_CONFIG_HOME = $ENV:XDG_CONFIG_HOME ? $ENV:XDG_CONFIG_HOME : (Join-Path $HOME '.config')
$ENV:XDG_CACHE_HOME = $ENV:XDG_CACHE_HOME ? $ENV:XDG_CACHE_HOME : (Join-Path $HOME '.cache')
$ENV:XDG_DATA_HOME = $ENV:XDG_DATA_HOME ? $ENV:XDG_DATA_HOME : ($HOME, '.local', 'share' -join [IO.Path]::DirectorySeparatorChar)
$ENV:PATH = ([io.path]::Combine($HOME,'.local','share','aquaproj-aqua', 'bin')), $ENV:PATH -join [IO.Path]::PathSeparator
# OR FOR MAX FLEXIBILITY
$ENV:PATH = ([io.path]::Combine($ENV:XDG_DATA_HOME, 'aquaproj-aqua', 'bin')), $ENV:PATH -join [IO.Path]::PathSeparator
Global Tooling Setup🔗
To create these files, navigate to the directory and run aqua init && aqua init-policy.
Run aqua policy allow "${XDG_CONFIG_HOME:-$HOME/.config}/aqua/aqua-policy.yaml" to allow global tooling that's customized.
Example Global Config🔗
Here's an example of what I drop into the global config for managing my global default for Go and other common cli tools.
---
# aqua - Declarative CLI Version Manager
# https://aquaproj.github.io/
checksum:
enabled: true
require_checksum: false
registries:
- type: standard
ref: v4.15.0 # renovate: depName=aquaproj/aqua-registry
- name: local
type: local
path: registry.yaml
packages:
- name: golang/[email protected]
tags: ['first']
- name: git-town/[email protected]
- name: golangci/[email protected]
- name: itchyny/[email protected]
- name: dandavison/[email protected]
- name: junegunn/[email protected]
- name: sharkdp/[email protected]
- name: magefile/[email protected]
- name: starship/[email protected]
- name: BurntSushi/[email protected]
- name: sharkdp/[email protected]
- name: x-motemen/[email protected]
- name: helm/[email protected]
- name: kubernetes-sigs/[email protected]
- name: kubernetes/kubectl
version: v1.25.2
- name: Schniz/[email protected]
- name: ajeetdsouza/[email protected]
- name: miniscruff/[email protected]
- name: direnv/[email protected]
# ... more packages here like minikube, charm tooling like gum, etc. All lazy installed `--only-link` or pre-installed with normal `aqua i`.
This is the custom location for packages not in the standard registry. While I recommend contributing upstream (it's really simple), sometimes less shareable tools for specific needs make sense to include here.
---
packages:
- type: go_install
name: mage-select
path: github.com/iwittkau/mage-select
description: CLI frontend for mage based on promptui.
search_words:
- mage
- module
- go
- type: github_release
repo_owner: alihanyalcin
repo_name: gomup
link: https://github.com/alihanyalcin/gomup/releases/
asset: 'gomup_{{trimV .Version}}_{{.OS}}_{{.Arch}}.tar.gz'
description: gomUP is a tool to keep track of outdated dependencies and upgrade them to the latest version. Designed for monorepo Go projects and Go projects that contain multiple modules.
search_words:
- gomod
- module
replacements:
darwin: Darwin
linux: Linux
windows: Windows
386: i386
amd64: x86_64
Used to allow the custom tooling that aqua can handle outside the standard packages.
For example, custom cargo install or go install packages.
Using With CI🔗
This is focused on ubuntu-latest as the windows agent has some quirks not addressed in this format.
This still uses pwsh on the ubuntu agent to avoid me having to rework logic for 2 platforms.
- pwsh: |
&curl -sSfL https://raw.githubusercontent.com/aquaproj/aqua-installer/v2.1.1/aqua-installer | bash -s -- -v v2.3.6
try {
$ENV:PATH = ([io.path]::Combine($HOME,'.local','share','aquaproj-aqua', 'bin')), $ENV:PATH -join [IO.Path]::PathSeparator
}
catch {
Write-Warning "unable to load aqua: $($_.Exception.Message)"
}
Write-Host "aqua version: $(& aqua version)"
&aqua update-aqua
Write-Host "aqua version (after update): $(& aqua version)"
$env:PATH = (Join-Path $(aqua root-dir) 'bin'), $env:PATH -join [IO.Path]::PathSeparator
Write-Host "run aqua install --tags first"
&aqua install --tags first
Write-Host "install remaining aqua tools"
aqua install --tags MYCUSTOM TAG # 👈 narrow down what you invoke
$ENV:PATH = (Join-Path $HOME '.config' @('aquaproj-aqua','bin')), $ENV:PATH -join [IO.Path]::PathSeparator
mage # ..... 👈 invoke commands now that things are installed
Created: 2023-09-16