Install
Install yoink with Homebrew, Cargo, curl, or a pre-built binary. Each method puts the same single binary on your PATH.
yoink is a single self-contained binary. It has no daemon, no config bootstrap, and no runtime.
Install yoink
Install the binary
Use one of the four methods.
brew install oddur/yoink/yoinkEach release updates the Homebrew tap (oddur/homebrew-yoink) automatically.
cargo install --git https://github.com/oddur/yoink yoinkThis command builds the latest main from source, not a tagged release. The MSRV is 1.95.
curl -LsSf https://github.com/oddur/yoink/releases/latest/download/yoink-installer.sh | shThe cargo-dist installer gets the correct tar.xz for your platform and puts the binary in ~/.cargo/bin/.
Download the tar.xz for your platform from the latest release:
yoink-aarch64-apple-darwin.tar.xzfor macOS Apple Siliconyoink-x86_64-apple-darwin.tar.xzfor macOS Intelyoink-x86_64-unknown-linux-gnu.tar.xzfor Linux x86_64
Extract the archive. Then put the binary on $PATH.
Make sure that yoink runs
yoink --version
The command prints the installed version.
Prerequisites for actual deploys
yoink does not install Docker. A deploy needs these items:
- Docker on each host: Docker runs, and the deploy user is in the
dockergroup. - SSH access from your laptop to each host: yoink uses
ssh://user@hostto reach the docker daemon. No docker socket is open over TCP. - Docker on your laptop, for local builds only:
yoink buildcallsdocker build.
Tailscale fits the SSH transport. See Networking.
Upgrading
Run the command for your install method:
brew upgrade oddur/yoink/yoink # Homebrew
cargo install --git https://github.com/oddur/yoink yoink --force # cargo
curl -LsSf https://github.com/oddur/yoink/releases/latest/download/yoink-installer.sh | sh # installer script
The GitHub releases page has the release notes for each version. yoink obeys SemVer. A minor version can add new fields, but it does not break existing yoink.yaml configs.
See also
- First deploy: the tutorial from a new host to a running app with two commands.
- Hetzner cx23 quickstart with HTTPS: a tutorial from an empty cloud account to live HTTPS.
- Networking: how yoink uses SSH and where Tailscale fits.
- CLI reference: each subcommand and flag.