surface

Install and update.

Install Kaitoi CLI on macOS, Windows, or Linux, choose the command for your work, and learn how to check, download, and apply updates.

Written for
Anyone using Kaitoi Code, Crew, or local services on their own computer.
You need
A supported macOS, Windows, or Linux computer

For setup and updates, see Install and update. Check kaitoi --version and use kaitoi code --help to confirm available commands. Older builds may interpret unsupported code acp or code serve commands as model prompts.

Kaitoi CLI brings Kaitoi Code, Crew, Runtime, and Connect to your computer in one installation. The official installers include Python and the bundled components; you do not need to install them separately.

Check the release page before installing. Updating checks published releases; it cannot install an unreleased version.

What the installation includes

Use kaitoi on its own for Code and Penny, or kaitoi ui / kaitoi dashboard for the dashboard. Add a command to go directly to the tool you need. Code can use Kaitoi-hosted models or a model you configure yourself. A Kaitoi account is needed for hosted models and connecting services to Studio, but is not required just to install the CLI or use Code with a local model.

One installation, several entry points. These are command names, not steps to run in order.

These entry points cover the bundled tools: kaitoi and kaitoi code open the coding assistant; kaitoi ui and kaitoi dashboard open the dashboard; kaitoi crew manages Crew runs; kaitoi runtime manages and runs local recipes; kaitoi connect manages service connections to Studio. You can open Code directly without starting Runtime or Connect. This command map is an explanation, not a terminal screenshot, and does not execute commands.

One-command installer scripts

Check that the latest release lists install.sh and install.ps1 as assets. If either is missing, use the manual downloads below. When those assets are available, the commands are:

On macOS or Linux:

curl -fsSL https://github.com/kaitoi-labs/kaitoi-cli/releases/latest/download/install.sh | sh

On Windows, in PowerShell 5.1 or 7:

irm https://github.com/kaitoi-labs/kaitoi-cli/releases/latest/download/install.ps1 | iex

The scripts verify the installer against the release's checksums.txt before installing. macOS and Windows also verify the Kaitoi Labs installer signature and ask for administrator permission. Linux installs the matching x86_64 or ARM64 AppImage for your user; its release checksum is the verification step.

The Windows PowerShell script runs setup silently with its default tasks after elevation. It enables the Windows Defender exclusion for the install folder and adds inbound and outbound firewall rules for frpc.exe, the tunnel helper. The script prints the exclusion warning before opening setup. To review and untick the exclusion, use the manual installer instead. Without the exclusion, Defender can quarantine bundled components; check its protection history if a tool disappears or stops launching. The firewall rules are part of setup.

The macOS/Linux script accepts these environment settings:

Setting Purpose
KAITOI_VERSION Select a published release number instead of the latest.
KAITOI_INSTALL_DIR Linux AppImage folder; default ~/.local/share/kaitoi-cli.
KAITOI_BIN_DIR Linux command-link folder; default ~/.local/bin.

The bundled CLI is distributed through these release installers, not PyPI.

Download for your computer

Choose an installer from the public releases. The links below follow the latest published release.

System Build Download
macOS Apple Silicon Kaitoi-CLI-macOS.dmg
Windows x64-compatible Windows Kaitoi-CLI-Windows-Setup.exe
Linux x86_64 or ARM64 Kaitoi-CLI-Linux.tar.gz

The Linux archive contains both AppImages and a script that selects the right one. There is no Intel Mac installer in this release series.

macOS

  1. Open the downloaded disk image.
  2. Open Install Kaitoi CLI.pkg and follow Apple's installer. It asks for permission to install for all users.
  3. Open a new terminal and run kaitoi --version.

The package installs Kaitoi CLI.app in Applications and places the kaitoi command in /usr/local/bin. You can also launch it from Applications.

Windows

  1. Run the downloaded setup and follow its prompts.
  2. Review the installer options, including the optional Windows Defender exclusion for the install folder.
  3. Close all PowerShell, Command Prompt, and Windows Terminal windows, then open a new terminal and run kaitoi --version.

Setup installs in C:\Program Files\Kaitoi CLI, adds that folder to the system PATH, and creates a Start menu shortcut. It requests administrator permission and adds firewall rules for the bundled Connect tunnel helper.

Linux

Extract the archive, then run the installer from the extracted files:

tar -xzf Kaitoi-CLI-Linux.tar.gz
./install-linux.sh

The script installs the matching AppImage under ~/.local/share/kaitoi-cli and creates ~/.local/bin/kaitoi. It replaces an existing command or symlink at that location. If ~/.local/bin is missing from PATH, add this to your shell profile and open a new terminal:

export PATH="$HOME/.local/bin:$PATH"

If launching the AppImage reports a missing FUSE 2 library, either install your distribution's FUSE 2 package or use the AppImage extraction fallback:

APPIMAGE_EXTRACT_AND_RUN=1 kaitoi --version

Check the installation and start

Verify the installed version and available commands:

kaitoi --version
kaitoi --help

Open a terminal in the folder you want to work on, then start Code directly:

kaitoi

kaitoi code works the same. For the dashboard instead, run kaitoi ui or kaitoi dashboard. Starting Code does not require starting Runtime or a Connect tunnel first.

To use your Kaitoi account, sign in through the browser:

kaitoi connect login

Complete sign-in in the browser and return to the terminal. CLI and Code share the saved login. If you plan to use your own local model, configure its provider instead. Continue with Your first Kaitoi Code session and Sign-in and configuration.

Keep the installation up to date

Bundled installations check for a newer release at most once a day when launched interactively. The check can offer an update; it does not install one without your choice. To check explicitly without downloading or installing:

kaitoi update --check

To see the available update choices:

kaitoi update

If an older installation does not recognize update, download the latest installer from the release page and follow the platform instructions above.

What happens next depends on how your copy was installed:

Installation When you choose to install an update
macOS package Verifies the download, Kaitoi Labs signature, and Apple notarization; asks for confirmation, then runs Apple's installer with administrator permission.
Windows setup Verifies the download and Kaitoi Labs signature; asks for confirmation, then starts the elevated installer.
Linux AppImage you own Downloads and verifies the replacement, checks that it starts, and swaps it in. The previous file is kept alongside it with a .previous suffix.
A package manager or source checkout Shows guidance for that installation method instead of replacing its files.
Unrecognized installation Offers a download for you to install manually.

The macOS and Windows update flows exit Kaitoi so its installed files can be replaced. Finish the installer, open a new terminal, and check kaitoi --version again. If the release cannot be read or verified, the update fails; that is not confirmation that you already have the latest version.

To download an available newer release without installing it:

kaitoi update --download-only

Or choose the destination folder explicitly:

kaitoi update --download-to ./kaitoi-downloads

Both leave installation to you. To disable launch-time update offers, set KAITOI_NO_UPDATE_CHECK=1 in your environment. You can still run kaitoi update --check explicitly; unset the variable before using the interactive update offer.

If a command is missing or an older copy opens

First open a new terminal. Then check which executable your shell finds.

On macOS or Linux:

type -a kaitoi

On Windows:

Get-Command kaitoi -All
& "C:\Program Files\Kaitoi CLI\kaitoi.exe" --version

An older installation earlier in PATH can shadow the new one. Correct the ordering so the intended installation is found first. On Windows, close the whole terminal application before reopening it so it receives the updated system PATH.

If code, crew, runtime, or connect reports a missing bundled component, reinstall using the official installer. If download verification fails, obtain a fresh copy from the same release and compare it with that release's checksums.txt. A checksum confirms a matching download; it does not replace publisher verification. For signature or notarization errors, use a verified official release rather than bypassing the check.

Last reviewed against Kaitoi on 26 October 2026. View this page as Markdown

Type at least two characters.