Skip to main content

​
Install

No Node.js required — one command installs the standalone binary and puts agentkit (and its alias ak) on your PATH:
Verify the install:
The binary installs to AGENTKIT_HOME (~/.agentkit by default), with compatibility links for agentkit and ak in AGENTKIT_BIN_DIR (~/.local/bin by default). When overriding these directories, use absolute paths and keep them separate. The install directory also contains required runtime assets such as templates/, lifecycle-templates/, harness/, skills/, im-proxies/, and vendor/; when manually moving or extracting a standalone release, keep these directories beside ak in the same install directory. To install a specific version, set the AGENTKIT_VERSION environment variable (defaults to latest). If the current terminal still cannot find the command, reopen the terminal or source the shell configuration printed by the installer.
The install script writes managed agentkit and ak dispatch entries into the zsh, bash, or fish startup configuration so the standalone CLI takes priority over Python commands with the same name from pip, pipx, venv, or Conda after the shell reloads. If the current environment already has a Python agentkit command, the installer preserves it and writes a restorable shim; the uninstall script restores that entry when it is still managed by the installer. Set AGENTKIT_NO_MODIFY_PATH=1 to skip automatic shell configuration changes and print the block to add manually.

​
Authentication

The CLI signs every cloud OpenAPI request. Provide credentials for the cloud provider or login mode you use:
Set these in your environment or a local .env (git-ignored):
SSO login caches short-lived STS credentials. When AK/SK credentials are not explicitly configured, runtime, knowledge, memory, tool, and other cloud commands use valid credentials from the active login profile. Run agentkit login again after the credentials expire.

​
Deploy in three steps

1

Scaffold a project

2

Build & deploy

3

Invoke the runtime

See the command reference, or run agentkit tree to print the command tree. To switch cloud provider or region, run agentkit config --cloud_provider byteplus --region ap-southeast-1 in the project.
Last modified on September 19, 2026