wavekat-cli 0.0.20

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

Full docs: https://wavekat.com/docs/cli/

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.

What you can do today

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

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

Crash reporting

wk sends anonymous crash and error reports to help us catch bugs we wouldn't otherwise see (a server response shape that breaks an older CLI, a panic in exports adapt, network errors). It's on by default in the shipped binary.

What we collect:

• CLI version and build SHA, OS / arch, subcommand name.
• A short error category (http_4xx, decode, network, auth_missing, panic, …) and a 200-char snippet of the error.
• For HTTP failures, a templated endpoint path (/api/projects/:id/annotations, never the real ID).
• A random anonymous install ID, generated once and stored alongside auth.json.

What we never collect:

• Request bodies or response bodies (beyond the 200-char snippet).
• Full URLs containing IDs, command-line arguments, file paths, environment variables, auth tokens, cookies, or anything you've typed at a prompt.

The scrubber is in source at src/telemetry.rs — you can read exactly what's filtered before sending.

To opt out:

wk config telemetry off          # persistent, until you re-enable
WK_TELEMETRY=0 wk projects list  # per-invocation
wk config telemetry status       # show current setting

Source builds without the telemetry cargo feature compile out the SDK entirely.

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'

Datasets — end-to-end

Producing a HuggingFace-loadable training set from a labelled project is three commands:

# 1. Snapshot the current labels into a frozen export.
wk exports create <project-id> \
  --name "smart-turn-zh 2026-04-28" \
  --review-status approved \
  --label-key end_of_turn \
  --label-key continuation \
  --split random --seed 42 --ratios 0.8,0.1,0.1

# 2. Download the resulting snapshot (manifest + every clip).
wk exports download <export-id> --out ./snapshots/smart-turn-zh

# 3. Convert it into Parquet shards consumable by HF datasets.
wk exports adapt smart-turn \
  --export-dir ./snapshots/smart-turn-zh \
  --out ./datasets/smart-turn-zh \
  --language zh

Then on the trainer side:

from datasets import load_dataset, Audio
ds = load_dataset(
    "parquet",
    data_files={
        "train":      "./datasets/smart-turn-zh/train.parquet",
        "validation": "./datasets/smart-turn-zh/validation.parquet",
        "test":       "./datasets/smart-turn-zh/test.parquet",
    },
).cast_column("audio", Audio(sampling_rate=16000))

The smart-turn adapter only knows two label keys — end_of_turn (→ 1) and continuation (→ 0). Anything richer is rejected; binary collapse of a richer label set must be an explicit user decision via the export filter, not a silent default in the adapter.

Every clip is decoded, downmixed to mono, resampled to 16 kHz, and re-encoded as 16-bit PCM WAV before being written into the parquet. This both validates the source bytes (corrupt or non-WAV clips fail at adapt time, with the failing path in the error) and guarantees the shards contain a uniform shape downstream notebooks can rely on.

API reference

Each command maps to a single platform endpoint:

Help and feedback

• wk --help (or wk <command> --help) for usage details.
• File issues at https://github.com/wavekat/wavekat-cli/issues.

License

Apache-2.0. See LICENSE.