Command line
The command line talks to the same public API as your code, as you (a personal access token), across every workspace you allow it.
Install
Section titled “Install”npm install -g @limitry/cliSign in
Section titled “Sign in”limitry loginYour browser opens: sign in, choose which workspaces the command line
may use and what it may do, and click Allow. A personal access
token for this computer is created (valid for 90 days, listed under
Account → API tokens) and stored in ~/.config/limitry/.
On a server or in CI there is no browser — pass a token instead, or set it in the environment (nothing is written to disk):
limitry login --token "$TOKEN" # or: echo "$TOKEN" | limitry loginLIMITRY_TOKEN=pat_… limitry whoamilimitry logout revokes the token and forgets it.
Choose a workspace
Section titled “Choose a workspace”limitry workspace listlimitry workspace use acme # the default for later commandslimitry workspace audit-events list --workspace other-co # one call elsewhereEvery API operation is a command
Section titled “Every API operation is a command”Each operation in the API reference is a command, named after its resource and action:
limitry workspace webhook-endpoints listlimitry workspace webhook-endpoints create --url https://example.com/hookslimitry workspace webhook-deliveries list we_123 --limit 10limitry workspace webhook-endpoints delete we_123 --yes- IDs in the path are arguments; other inputs are flags
(
limitry <command> --helplists them, with descriptions). --data '{…}'sends a whole JSON body.- Lists print one page; the last line names the
--cursorfor the next. - Writes send an idempotency key for you.
- An operation that cannot be undone asks for
--yes. limitry api <method> <path>calls any endpoint directly.
Scripts and agents
Section titled “Scripts and agents”Add --json to any command for the API’s exact JSON on stdout. Errors
then go to stderr as JSON too — the API’s
error envelope with the HTTP status:
limitry workspace webhook-endpoints list --json | jq '.items[].url'{ "error": { "code": "forbidden", "message": "…", "status": 403, "requestId": "…" }}Exit codes: 0 success, 1 failure (any error, including a refused
API call or a missing flag).