VividKit Crystal clear AI coding
VI
Choose Your Setup Get Started with AgentKit Continue with ClaudeKit Migrate from ClaudeKit to AgentKit Clean cutover from ClaudeKit What Is AgentKit? How AgentKit Works AgentKit Kits, Skills, Agents & Hooks AgentKit Runtime Support AgentKit Desktop App AgentKit Configuration AgentKit CLI Quick Reference AgentKit Skills Cheatsheet AgentKit Workflows AgentKit Statusline Update AgentKit CLI & Kits AgentKit Helper Clean reinstall of AgentKit AgentKit Troubleshooting What is ClaudeKit? ClaudeKit CLI Guide Command Finder Commands Cheat Sheet Workflow Recipes CLI Quick Reference Claude Mechanics Permission Modes ClaudeKit Hooks Coexistence ClaudeKit x Codex CK → Other coding tools How ClaudeKit Works Inside ClaudeKit Finding Your Unknowns Session Recovery Fix from Logs UI/UX Guide Accounts Switcher IDE Config Remote Control Codex App System Diagramming UI Review Gate Promotions Support VividKit
AgentKit · Onboarding Recommended

AgentKit Installation

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

Overview

Five steps

  1. 1

    Install the ak CLI

    Signed installer — macOS/Linux or Windows PowerShell.

  2. 2

    Verify

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

  3. 3

    First-run setup

    ak setup writes preferences (adapters, default kit, telemetry). Does not log in or install a Kit.

  4. 4

    Log in & install a Kit

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

  5. 5

    Invoke a Skill in the runtime

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

ak onboard runs only missing steps (setup, login, Kit install). --yes accepts prompts — it does not force-overwrite or take over ownership.

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
› Beta channel

Install the beta ak CLI (opt-in).

beta 
curl -fsSL https://agentkit.best/install.sh | AK_CHANNEL=beta 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.

› Fallback if the primary host fails
releases host 
irm https://releases.agentkit.best/install.ps1 | iex
› Pin a version or install directory

Leave unset unless you need that control. Replace x.y.z with a semantic version. AK_INSTALL_DIR changes the destination directory. Quote the value — do not use < > (the shell treats those as redirection).

shell 
curl -fsSL https://agentkit.best/install.sh | AK_VERSION='x.y.z' sh
# Optional install directory
# curl -fsSL https://agentkit.best/install.sh | AK_INSTALL_DIR="$HOME/bin" sh

02

Verify

shell 
ak --version
ak doctor --json

Run ak --version for the CLI on this machine. Stable and beta are separate channels — this page does not pin a version number.

Upgrade an existing CLI

shell 
ak self-update --channel stable --yes
ak self-update --beta --yes

Already on ClaudeKit? Preview a move to AgentKit: ak migrate --from=ck .

03

First-run setup (ak setup)

Writes AgentKit preferences. Does not sign in to the registry and does not install Kit content.

shell 
ak setup

The wizard detects available runtime login state, lets you choose adapters, then updates ~/.agentkit/config.yaml (default kit, telemetry). Re-running is safe — it does not copy runtime credentials.

04

Log in (ak login), then install a Kit

Before installing licensed remote Kits, authenticate to the registry. Recommended: API key (regular use and CI). Email + OTP when you are in an interactive terminal.

API key (recommended)

Recommended

Create a user API key in the Account Dashboard, then run this locally with your real key. Suits regular use and non-interactive hosts. AgentKit stores the API key and CLI session in restricted files under ~/.agentkit/auth.

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

Email + OTP

Sends a one-time code to your email. The CLI prompts Enter OTP code. The OTP is not stored on disk; the CLI session keeps a rotating refresh credential.

shell 
ak login --email you@example.com
ak whoami

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).

05

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.

Get Desktop (30% OFF) → Desktop App guide

Next