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, with agentkit and ak symlinks in ~/.local/bin. If the command isn’t found, add ~/.local/bin to your PATH. To install a specific version, set the AGENTKIT_VERSION environment variable (defaults to latest).

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