AgentKit · Onboarding Recommended

AgentKit Installation

From zero to a first Skill with AgentKit: install the ak CLI, verify, sign in, install a Kit, invoke in your runtime.

Overview

Four steps

  1. 1

    Install ak CLI

    Signed installer — macOS/Linux or Windows PowerShell.

  2. 2

    Verify

    ak --version and ak doctor to confirm a clean install.

  3. 3

    Log in & install a Kit

    ak login (email + OTP, API key, or license key), then install a Kit for your runtime.

  4. 4

    Invoke a Skill in the runtime

    Installing a Kit does not run a workflow — open the assistant.

01

Install the AgentKit CLI

Pick your platform, run one command, then open a new terminal.

Unix

macOS / Linux

install.sh
install.sh
curl -fsSL https://agentkit.best/install.sh | sh
Fallback if the primary host fails

Use the release host when agentkit.best is unreachable.

releases host
curl -fsSL https://releases.agentkit.best/install.sh | sh

Windows

PowerShell

install.ps1
install.ps1
irm https://agentkit.best/install.ps1 | iex

Run in PowerShell (not CMD). After install, open a new terminal window.

02

Verify

shell
ak --version
ak doctor --json

03

Log in (ak login), then install a Kit

Before installing licensed remote Kits, authenticate to the registry with one of the methods below. Recommended for most users: email + OTP.

Email + OTP (recommended)

Common

Sends a one-time password (OTP) to your email. The CLI prompts Enter OTP code — type the code from your inbox. The OTP is not stored on disk; the CLI session keeps a rotating refresh credential (not the OTP itself).

shell
ak login --email you@example.com
# Prompt: Enter OTP code:
ak whoami

API key (scripts / CI)

Key from your web profile. Suited to non-interactive hosts. The private API key is stored in the session.

shell
ak login --api-key ak_live_... --no-interactive

License key (App / device)

Activates a device for an App session (separate from the CLI email/API slot). Mainly for Desktop — does not grant Engineer / Marketing Kits by itself.

shell
ak login --license-key ak_license_... --no-interactive

After login: install a Kit

Install a Kit for the runtime you use. Project scope is the default; add --global for user-wide availability. Installing a Kit does not run a workflow — restart the coding assistant or open a new session, then invoke a Skill (for example /ak:plan or $ak:plan).

04

Optional: Desktop App (extra purchase)

Desktop is not required to use Kits. Buy it only if you want the local management UI — App license is separate from Kits. VividKit referral: 30% off.

Next