Quickstart

Install

No Node.js required — one command installs the standalone binary and puts agentkit (and its alias ak) on your PATH:

wget
curl

wget -qO- https://agentkit-cli.tos-cn-beijing.volces.com/install.sh | sh

curl -fsSL https://agentkit-cli.tos-cn-beijing.volces.com/install.sh | sh

Verify the install:

agentkit --help

The binary installs to ~/.agentkit, with agentkit and ak symlinks in ~/.local/bin. 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. 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:

AK/SK
BytePlus
SSO

Set these in your environment or a local .env (git-ignored):

VOLCENGINE_ACCESS_KEY=...
VOLCENGINE_SECRET_KEY=...
VOLCENGINE_REGION=cn-beijing   # optional, defaults to cn-beijing

Set BytePlus credentials, then write the default cloud provider and region to user-wide config:

BYTEPLUS_ACCESS_KEY=...
BYTEPLUS_SECRET_KEY=...
agentkit --provider byteplus config --global --region ap-southeast-1

Browser login that stores short-lived STS credentials.

agentkit login <sso-address>
agentkit whoami

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

Scaffold a project

agentkit init my-agent --template basic
cd my-agent

Build & deploy

agentkit launch

Invoke the runtime

agentkit invoke run "hello"

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.

Getting Started

AI-Friendly

Command reference

Install

Authentication

Deploy in three steps