📦 Installation

AgentKit is distributed as a set of binaries which you'll need to download from the latest release, extract, make executable, and place on your PATH.

info

We're aware that placing binaries on PATH isn't great for versioning. Packaging is on the roadmap.

GNU/Linux

What steps are required for you depend on your Linux distribution.

To use our binary distribution, place it somewhere on your PATH. We suggest ~/.local/bin.

mkdir -p ~/.local/bin
curl -L https://github.com/throwparty/agentkit/releases/download/latest/agentkit_Linux_$(uname -m).tar.gz -o agentkit-latest.tar.gz
tar -xf agentkit-latest.tar.gz -C ~/.local/bin
chmod +x ~/.local/bin/agentkit-*
rm -f agentkit-latest.tar.gz

Then, add the following to your shell's rc:

export PATH="$PATH:~/.local/bin"

macOS

To use our binary distribution, place it somewhere on your PATH. We suggest ~/.local/bin.

mkdir -p ~/.local/bin
  curl -L https://github.com/throwparty/agentkit/releases/download/latest/agentkit_Darwin_$(uname -m).tar.gz -o agentkit-latest.tar.gz
tar -xf agentkit-latest.tar.gx -C ~/.local/bin
chmod +x ~/.local/bin/agentkit-*
rn -f agentkit-latest.tar.gz

Then, add the following to your shell's rc:

export PATH="$PATH:~/.local/bin"

Windows

To use our binary distribution, place it somewhere on your PATH. We suggest ~/.local/bin.

$localBin = Join-Path $env:USERPROFILE ".local" "bin"
New-Item -ItemType Directory -Force -Path $localBin | Out-Null

$zipPath = Join-Path $env:TEMP "agentkit-latest.zip"
$url = "https://github.com/throwparty/agentkit/releases/download/latest/agentkit_Windows_x86_64.zip"
Invoke-WebRequest -Uri $url -OutFile $zipPath
Expand-Archive -Path $zipPath -DestinationPath $localBin -Force

$oldPath = [System.Environment]::GetEnvironmentVariable("Path", "User")
if (($oldPath -split ';') -notcontains $localBin) {
  [System.Environment]::SetEnvironmentVariable("Path", "$oldPath;$localBin", "User")
}

You can now proceed to the documentation for each tool.