Skip to content

Commit 1bb0d93

Browse files
wavekat-easonclaude
andcommitted
docs: refresh docs/site command list
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 95b7bd4 commit 1bb0d93

2 files changed

Lines changed: 37 additions & 1 deletion

File tree

docs/site/index.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,31 @@ order: 1
1414
|---------|---------------|
1515
| `wk login` / `wk logout` | Sign in via your browser, or sign out |
1616
| `wk me` | Who you're signed in as |
17-
| `wk projects list` | Paginated table of projects you can see |
17+
| `wk projects list` | Projects you can see, with role, counts, and review progress |
1818
| `wk projects show <id>` | Details for one project |
1919
| `wk annotations list <project-id>` | Paginated annotations with inline ASR text |
20+
| `wk files list <project-id>` | Files in a project, with per-label counts and reservation state |
21+
| `wk files reserve <id> [<id>…]` | Reserve files for the test set |
22+
| `wk files unreserve <id> [<id>…]` | Release a test-set reservation |
23+
| `wk files summary <project-id>` | File / annotation / labelled-seconds totals |
2024
| `wk exports list <project-id>` | Exports for a project |
2125
| `wk exports show <export-id>` | Filter, split policy, counts for one export |
2226
| `wk exports create <project-id>` | Snapshot the current label set into a frozen export |
2327
| `wk exports download <export-id>` | Fetch manifest + every clip |
2428
| `wk exports delete <export-id>` | Soft-delete an export |
2529
| `wk exports adapt smart-turn …` | Convert a downloaded export into HF `datasets` Parquet shards |
30+
| `wk models list <project-id>` | Models trained in a project (lineage, metrics, status) |
31+
| `wk models show <model-id>` | Full model row including artifacts |
32+
| `wk models push …` | Register a trained model + upload its artifacts |
33+
| `wk models download <model-id>` | Fetch a specific model artifact |
34+
| `wk version` | CLI + API versions, with `--json` |
35+
| `wk update` | Self-update to the latest release (or `--check`, `--version`) |
36+
| `wk agents` | Print the LLM-facing `AGENTS.md` guide |
2637

2738
Every list command supports `--page` / `--page-size` and prints a ready-to-paste `Next:` line when more pages exist. Add `--json` to any command for machine-readable output.
2839

40+
Don't see what you need above? `wk` is built on clap — every subcommand has self-describing help. Run `wk --help`, `wk <group> --help`, or `wk <group> <command> --help` to see every flag, type, and default for any command this binary supports.
41+
2942
Supported on macOS (Apple Silicon + Intel) and Linux (x86_64 + aarch64).
3043

3144
## Where to go next

docs/site/reference.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,15 +40,38 @@ Each command maps to a single platform endpoint:
4040
| `wk login` | Loopback OAuth + `GET /api/me` |
4141
| `wk logout` | `POST /api/auth/cli/tokens/revoke-current` |
4242
| `wk me` | `GET /api/me` |
43+
| `wk version` | Local binary + `GET /api/health` |
44+
| `wk update` | `GET /repos/wavekat/wavekat-cli/releases/latest` (GitHub) + re-runs `install.sh` |
45+
| `wk agents` | Local-only; prints the bundled `AGENTS.md` |
4346
| `wk projects list` | `GET /api/projects` |
4447
| `wk projects show <id>` | `GET /api/projects/{id}` |
4548
| `wk annotations list <project-id>` | `GET /api/projects/{id}/annotations` |
49+
| `wk files list <project-id>` | `GET /api/projects/{id}/files` |
50+
| `wk files reserve <id> [<id>…]` | `POST /api/files/{id}/test-reservation` (one call per id) |
51+
| `wk files unreserve <id> [<id>…]` | `DELETE /api/files/{id}/test-reservation` (one call per id) |
52+
| `wk files summary <project-id>` | `GET /api/projects/{id}/files/summary` |
4653
| `wk exports list <project-id>` | `GET /api/projects/{id}/exports` |
4754
| `wk exports show <export-id>` | `GET /api/exports/{id}` |
4855
| `wk exports create <project-id>` | `POST /api/projects/{id}/exports` |
4956
| `wk exports download <export-id>` | `GET /api/exports/{id}/manifest` + per-clip `GET /api/exports/{id}/clips/{annotation-id}` |
5057
| `wk exports delete <export-id>` | `DELETE /api/exports/{id}` |
5158
| `wk exports adapt smart-turn` | Local-only; reads a downloaded snapshot |
59+
| `wk models list <project-id>` | `GET /api/projects/{id}/models` |
60+
| `wk models show <model-id>` | `GET /api/models/{id}` |
61+
| `wk models push …` | `POST /api/projects/{id}/models` + artifact upload |
62+
| `wk models download <model-id>` | `GET /api/models/{id}/artifacts/{name}` |
63+
64+
## Discovering commands
65+
66+
This table is a snapshot; the binary itself is authoritative. Every subcommand has self-describing help via clap:
67+
68+
```sh
69+
wk --help # top-level groups
70+
wk exports --help # one group
71+
wk exports create --help # all flags, types, defaults
72+
```
73+
74+
When in doubt, run `--help` rather than guessing.
5275

5376
## Credentials file
5477

0 commit comments

Comments
 (0)