Kamui Platform Kamui Platform Docs
EN JA

CLI Installation

This guide explains how to install the Kamui CLI (kamui command).

System Requirements

  • macOS (Intel / Apple Silicon)
  • Linux (x86_64 / ARM64)
  • Windows (x86_64)

Installation Methods

Homebrew (Recommended for macOS / Linux)

brew install kamui-project/tap/kamui

To update:

brew upgrade kamui

Binary Download

Download directly from GitHub Releases.

macOS

# Apple Silicon (M1/M2/M3)
curl -L https://github.com/kamui-project/cli/releases/latest/download/kamui_darwin_arm64.tar.gz | tar xz
sudo mv kamui /usr/local/bin/

# Intel
curl -L https://github.com/kamui-project/cli/releases/latest/download/kamui_darwin_amd64.tar.gz | tar xz
sudo mv kamui /usr/local/bin/

Linux

# x86_64
curl -L https://github.com/kamui-project/cli/releases/latest/download/kamui_linux_amd64.tar.gz | tar xz
sudo mv kamui /usr/local/bin/

# ARM64
curl -L https://github.com/kamui-project/cli/releases/latest/download/kamui_linux_arm64.tar.gz | tar xz
sudo mv kamui /usr/local/bin/

Windows

  1. Download kamui_windows_amd64.zip from GitHub Releases
  2. Extract the ZIP file
  3. Place kamui.exe in a directory in your PATH

Install with Go

If you have Go installed:

go install github.com/kamui-project/cli/cmd/kamui@latest

Verify Installation

kamui --version

If the version number is displayed, installation was successful.

Initial Setup

Login

kamui login
  1. A browser window opens automatically
  2. Authenticate with your GitHub account
  3. After successful authentication, "Successfully logged in" appears in the terminal

💡 Credentials are stored in ~/.kamui/config.json.

Verify Login

kamui projects list

If your project list is displayed, you're successfully logged in.

Logout

kamui logout

This clears stored credentials.

Uninstall

Homebrew

brew uninstall kamui

Binary

sudo rm /usr/local/bin/kamui
rm -rf ~/.kamui

Troubleshooting

Browser doesn't open automatically

Copy and paste the URL displayed in the terminal into your browser manually.

"command not found" error

Check that your PATH is set correctly.

# Check binary location
which kamui

# Check PATH
echo $PATH

Authentication errors

Your token may have expired. Log in again.

kamui logout
kamui login

Next Steps