Skip to content
AFK

Installation

AFK is not published to a registry. You consume it by cloning the repo and linking the CLI globally.

Terminal window
git clone https://github.com/theodo-group/afk.git ~/afk
cd ~/afk/cli
bun install
bun link              # registers @afk/cli globally

bun link puts a symlink at ~/.bun/bin/afk that resolves back to this checkout. If ~/.bun/bin is on your PATH (Bun’s installer adds it by default), afk is now usable from any project. Editing the source in your checkout takes effect immediately — no relink needed.

Updating: git pull && bun install. There is no version pinning; you run whatever sha you checked out.

Prerequisites

Section titled “Prerequisites”

On every developer machine

Section titled “On every developer machine”
  • Bun (runtime)
  • Docker (image builds)
  • A working git credential helper that can read your remote (gh auth setup-git is the easiest if you have the GitHub CLI installed)

Per Backend

Section titled “Per Backend”
  • Terraform ≥ 1.10 (for S3 native state locking)
  • AWS CLI (credential chain) with creds for the target account
  • session-manager-plugin (required for afk attach)
  • npm (the sweeper Lambda is bundled with esbuild at terraform apply time)