wavekat-cli 0.0.4

Command-line client for the WaveKat platform (wk)
wavekat-cli-0.0.4 is not a library.

Crates.io

Command-line client (wk) for the WaveKat platform. Sign in once with your browser and inspect projects and annotations from the terminal.

Quick start

curl -fsSL https://github.com/wavekat/wavekat-cli/releases/latest/download/install.sh | sh
wk login
wk projects list

That's it — you're signed in and looking at your projects. Run any command with --help to see all flags, or jump to the Examples.

Dataset export commands (wk exports …) are coming next — see What's next.

What you can do today

Command What it shows
wk login / wk logout sign in via your browser, or sign out
wk me who you're signed in as
wk projects list paginated table of projects you can see
wk projects show <id> details for one project (--json for raw)
wk annotations list <project-id> paginated annotations with inline ASR text

Every list command supports --page / --page-size (default 20) and prints a ready-to-paste Next: line when more pages exist. wk annotations list also takes --label, --review-status, --file-id, and --created-by filters. Add --json to any command for machine-readable output you can pipe into jq.

Supported on macOS (Apple Silicon + Intel) and Linux (x86_64 + aarch64).

Install

curl | sh (recommended)

curl -fsSL https://github.com/wavekat/wavekat-cli/releases/latest/download/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

Each release attaches tarballs and .sha256 checksums for the four supported targets — drop the wk binary anywhere on your PATH.

From source

cargo install --git https://github.com/wavekat/wavekat-cli wavekat-cli
# or, from a clone:
git clone https://github.com/wavekat/wavekat-cli && cd wavekat-cli
cargo install --path .
wk --version

Sign in

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 is available locally, run:

wk login --no-browser

wk prints a URL — open it on any browser that can reach the loopback port (typically ssh -L 1234:127.0.0.1:1234 remote-host, then open the URL the CLI prints).

CI / pre-minted token

Pre-mint a token from your platform profile, then:

WK_TOKEN='wkcli_…' 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.

Examples

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

wk projects list --page-size 5

wk projects list --json | jq '.projects[].name'

# Default: human-readable table with the ASR snippet under each row.
wk annotations list <project-id> --label end_of_turn --review-status approved

# Pipe raw JSON into jq for scripting.
wk annotations list <project-id> --label end_of_turn --review-status approved --json \
  | jq '.annotations | length'

API reference

Each command maps to a single platform endpoint:

Command Endpoint
wk login loopback OAuth + GET /api/me
wk logout POST /api/auth/cli/tokens/revoke-current
wk me GET /api/me
wk projects list GET /api/projects
wk projects show <id> GET /api/projects/{id}
wk annotations list <project-id> GET /api/projects/{id}/annotations

What's next

The next milestone for the CLI is the dataset export feature, landing together with the matching platform changes. It will add:

  • wk exports create / list / show / download.
  • A built-in adapter that materialises the canonical snapshot into the HuggingFace datasets format Pipecat smart-turn consumes.

Help and feedback

License

Apache-2.0. See LICENSE.