Getting Started

Install

curl | sh (recommended)

curl -fsSL https://dl.wavekat.com/wk/install.sh | sh

Pin a specific version with WK_VERSION=vX.Y.Z, or pick the install directory with WK_INSTALL_DIR=$HOME/bin. Defaults to /usr/local/bin if writable, else $HOME/.local/bin.

Prebuilt binaries

Every release is published to https://dl.wavekat.com/wk/<tag>/ as wk-<tag>-<target>.tar.gz plus a .sha256 checksum, for the four supported targets; https://dl.wavekat.com/wk/latest names the current tag. Drop the wk binary anywhere on your PATH.

Uninstall

wk uninstall          # shows what it will remove, then asks for --yes
wk uninstall --yes

This revokes the sign-in token, deletes auth.json, and deletes the wk binary. Add --keep-config to keep your sign-in and preferences, so a reinstall starts already signed in. A cargo install build is left for cargo uninstall wavekat-cli.

wk login

wk opens your browser to the WaveKat platform, you click Authorize, and the terminal confirms you’re signed in. The browser tab will say “You can close this tab” when it’s done.

You can list and revoke tokens any time from your platform profile page. wk logout revokes the current token before clearing the local file.

Headless / SSH

If no browser can reach this machine (over SSH, or a server with no display), run:

wk login --no-browser

wk prints a link. Open it in a browser on any device, allow it, and paste the one-time code the page shows at the Code: prompt. Over SSH, wk login does this on its own.

From an AI assistant or a script

With no terminal to paste into, wk login prints the link and exits. Open it on any device, allow it, and give the code the page shows to your assistant, which finishes with:

wk login --code ABCD-EFGH

The link and the code work for 10 minutes.

CI / existing token

To reuse a token on a machine nobody signs in on, copy the token value from auth.json on a machine where you ran wk login (see below), then:

WK_TOKEN='wk_…' WK_BASE_URL='https://platform.wavekat.com' wk login

Where credentials are stored

Platform	Path
macOS	`~/Library/Application Support/wavekat/auth.json`
Linux	`~/.config/wavekat/auth.json`
Windows	`%APPDATA%\wavekat\auth.json`

Mode is 0600 on Unix. Run wk logout to remove it.

Your first commands

wk me
# login: somebody
# id:    42
# role:  user

wk projects list --page-size 5

That’s it — you’re signed in and looking at your projects. Run any command with --help for all flags, or continue to Usage for common workflows.