CLI Reference
Every tch command.
The CLI mirrors the API one-to-one. Most customers use the API directly; the CLI is here for quick checks, scripting, and local development.
Source resolution works the same everywhere: alias → full UUID → short UUID (first 8 chars) → canonical URL. Use whichever is convenient.
Bootstrap & Auth
| tch signup | Create account: prompts for the 6-digit code emailed to you (3 attempts, 30 minutes), then writes config and prints the API key once |
| tch login [--workspace name] | Log in with email and password and save an API key to config: an owner’s key is account-scoped, everyone else’s is scoped to their workspace (--workspace picks it) |
| tch login --api-key | Save an existing API key to config instead (prompted, so it stays out of shell history) |
| tch verify <code> | Verify email with the 6-digit code |
| tch verify --resend | Request a new verification code |
| tch whoami | Show current identity and workspace |
| tch reset-password | Reset a forgotten password with a 6-digit code emailed to you |
| tch help | Show the command list |
| tch change-email | Change your login email: prompts for the new address and your current password, then for the 6-digit code emailed to the new address (3 attempts). Your API key and config stay valid |
Subscribe
| tch subscribe <url> [--alias name] | Start monitoring a spec |
Sources & Versions
| tch sources [--all] | List sources (--all = owner cross-workspace view) |
| tch alias <source> <alias> | Set a human-friendly name |
| tch status [--all] | Cross-source summary |
| tch versions <source> [--limit N] | List stored versions |
| tch view <source> [version] | View a stored spec |
| tch delete <source> [version] | Delete a source, or one version by number (as shown by tch versions) |
Diffs
| tch diffs <source> [--limit N] | List stored diffs |
| tch diff <source> <v1> <v2> | Diff two versions (computes on demand if not stored) |
| tch show-diff <diff_id> | Show a stored diff by UUID |
| tch show-diff <source> <v1> <v2> | Show a stored diff by source and version numbers |
| tch diff-openapi <source> | Diff the latest two versions and store the diff (member role or higher) |
API Keys
| tch keys create <name> | Create a new API key |
| tch keys list | List keys (alias: ls) |
| tch keys revoke <key_id> | Revoke a key (alias: rm) |
Polling & Webhooks
tch polls is an alias for tch poll.
| tch poll enable <source> | Turn polling on |
| tch poll disable <source> | Turn polling off |
| tch poll set-interval <source> <interval> | e.g. 60, 30m, 2h, 1d |
| tch poll add-webhook <source> <url> | Add a delivery target |
| tch poll list-webhooks <source> | List webhooks on a source |
| tch poll remove-webhook <source> <id|alias> | Remove a webhook from a source |
| tch poll test-webhook <source> [--webhook id] | Fire a test delivery to a source’s webhooks, or one of them (--all instead of a source: every source in the workspace) |
| tch poll status [source] | Show polling health |
Notifications
| tch notify add-email <source> <email> | Add an email recipient |
| tch notify list-emails <source> | List recipients |
| tch notify remove-email <source> <email|id> | Remove a recipient |
| tch notify set-trigger <source> <email|id> <breaking|any_change> | Set notification threshold |
| tch notify status <source> | Show a source’s notification settings |
Members & Invites
tch invites is an alias for tch invite.
| tch members list | List account members (alias: ls) |
| tch members remove <email> | Remove a member from the account (owners too, while another owner remains; alias: rm) |
| tch members set-role <email> <owner|admin|member|readonly> | Set a member's account role — the only way to make an owner; an account always keeps at least one owner |
| tch invite send <email> [--role admin|member|readonly] | Invite someone to a workspace (owner is account-level: use members set-role) |
| tch invite list | List pending invites (alias: ls) |
| tch invite revoke <invite_id> | Revoke a pending invite (alias: rm) |
| tch accept-invite <token> | Accept a pending invite: shows its workspace and role, then asks for a password |
| tch audit [--limit N] | View recent audit log entries |
Workspaces
tch workspaces is an alias for tch workspace.
| tch workspace create <name> | Create a new workspace |
| tch workspace list | List workspaces (alias: ls) |
| tch workspace list-members [workspace] | List members |
| tch workspace add-member <workspace> <email> [--role admin|member|readonly] | Add an account member to a workspace |
| tch workspace update-member <workspace> <email> --role admin|member|readonly | Change a member's workspace role |
| tch workspace delete <workspace> [--force] | Delete a workspace by name or UUID (--force removes its members first; alias: rm) |
| tch workspace add-profile <profile> <workspace_id> | Add a local config profile pointed at a workspace (use it with --profile) |
| tch workspace list-profiles | List the local profiles in ~/.trackchanges/config |
| tch workspace remove-profile <profile> | Remove a local profile |