Getting started
Installation
Install the ak command-line tool, verify the binary, and pick a release channel — about two minutes on any platform.
AgentKit ships as a single binary, ak. The installer detects your platform,
fetches a release-authenticated archive for your channel, and installs ak
into your install directory. It is idempotent — re-run it any time to upgrade
in place.
Quick install
curl -fsSL https://agentkit.best/install.sh | shInstalls to ~/.local/bin on the stable channel by default. The installer
does not modify your shell profile — add ~/.local/bin to PATH if ak
is not found after install.
irm https://agentkit.best/install.ps1 | iexInstalls to %USERPROFILE%\bin, adds it to your user PATH, and uses the
stable channel by default. Open a new terminal afterward.
If a corporate network blocks the primary domain, the release host
releases.agentkit.best serves the byte-identical installer with the same
verification chain — swap it into either command above.
Verify and configure
Verify the binary
Confirm the installed version and that ak resolves on your PATH:
ak --versionIf you get command not found, make sure the install directory
(~/.local/bin, or %USERPROFILE%\bin on Windows) is on your PATH.
Choose a channel (optional)
The default is stable. To install the beta channel instead, set
AK_CHANNEL before piping the installer:
curl -fsSL https://agentkit.best/install.sh | AK_CHANNEL=beta sh$env:AK_CHANNEL = "beta"; irm https://agentkit.best/install.ps1 | iexClear the first-launch warning
Release metadata and archive hashes are cryptographically signed for provenance. AgentKit binaries are not yet Apple-notarized or Microsoft-signed, so the OS may warn on first launch. See the note for your platform below — it is a one-time step per install.
First launch by platform
Binaries fetched with curl do not carry the quarantine flag, so the CLI
just runs. If you downloaded through a browser instead, clear the flag once:
xattr -d com.apple.quarantine ~/.local/bin/akNo sudo needed — you own the file.
No extra step for the CLI. Ensure your install directory is on PATH:
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrcThe first time you run an unrecognized binary, SmartScreen may show "Windows protected your PC." Click More info → Run anyway. Windows records the approval for that binary on that machine; later runs are silent.
Install-time overrides
Set these before piping the installer to change its behavior.
| Variable | Default | Effect |
|---|---|---|
AK_CHANNEL | stable | Release channel to install (stable or beta). |
AK_VERSION | latest | Pin an exact version, e.g. AK_VERSION=1.0.0. |
AK_INSTALL_DIR | ~/.local/bin (%USERPROFILE%\bin on Windows) | Target install directory. |
Updating
ak verifies signed release metadata and the target artifact before replacing
itself. Always pass --channel stable on the stable docs path — an empty
channel defaults to beta:
ak self-update --check --channel stable # read-only: is a newer release available?
ak self-update --channel stable --yes # apply (requires --yes)If ak was installed by a package manager, self-update reports the managed
install and prints the manager-native command instead of replacing files.
Uninstall
Remove installed kits first so AgentKit can unregister them cleanly, then delete the binary and state:
ak kit list-kits
ak kit uninstall <kit> --yes # repeat per installed kit
rm ~/.local/bin/ak # macOS / Linux
rm -rf ~/.agentkit # project registry, kits, cachesOn Windows, remove ak.exe from your install directory and delete
%USERPROFILE%\.agentkit.