Install¶
Requirements¶
- AWS CLI v2 installed and on your
PATH - For 1Password secret resolution:
opCLI installed and signed in - macOS 12+, Linux (amd64/arm64), or Windows via Git Bash
macOS¶
To upgrade:
Linux¶
Install script¶
The script detects your architecture and installs the binary to ~/.local/bin. Make sure ~/.local/bin is on your PATH.
Manual¶
Download the binary for your architecture from the releases page, make it executable, and move it to somewhere on your PATH.
Windows (Git Bash)¶
yak works best inside Git Bash using the linux_amd64 binary. This avoids Windows terminal compatibility issues with the interactive TUI.
- Download
yak_linux_amd64from the latest release - Place it in
~/bin(Git Bash adds this toPATHautomatically) - Rename it to
yakwith no extension
See the Windows guide for full setup including shell integration.
Verify¶
Next steps¶
- Quickstart — get up and running in five minutes
- Configuration reference — full config file documentation
- Shell integration — set up
AWS_PROFILEexport