Skip to main content

Commands

Every collector command, grouped as the CLI itself groups them. collector <command> --help shows each one's options.

An issue can be named by its id or by pasting its page's address. Lists show one page (--limit, up to 100) with a --cursor … hint for the next, or all of them with --all.

Signing in​

CommandWhat it does
collector loginSigns in by approving a code in the browser, on this machine or any other. See Signing in.
collector logoutRevokes this machine's token and forgets it.
collector whoamiWho the token is, what access it has, which organizations it belongs to.
collector use [<org>[/<project>]]Sets the organization, and optionally the project, the other commands use. --clear forgets it.

Projects and setup​

CommandWhat it does
collector projects listThe organization's projects, with their unresolved issues.
collector projects create <name>Creates one and prints its DSN.
collector projects show [<project>]One project, with its DSN.
collector projects edit [<project>] --name <name>Renames it (owners and admins); the address stays.
collector projects mute [<project>]Turns its issue emails off, for you.
collector projects unmute [<project>]Turns them back on.
collector dsn [<project>]Only the DSN, for scripts: COLLECTOR_DSN=$(collector dsn).
collector origins listThe project's domains and their status.
collector origins allow <origin>Accepts that domain's events (a bare host means https://).
collector origins block <origin>Refuses its events.
collector origins forget <origin>Forgets it: its next event asks again.
collector upload-tokens listThe project's upload tokens.
collector upload-tokens create <name>Creates one and prints the secret, once.
collector upload-tokens revoke <id>Revokes it.
collector server-keys listThe project's server keys.
collector server-keys create <name>Creates one and prints the secret, once.
collector server-keys revoke <id>Revokes it.

Issues​

CommandWhat it does
collector issues list [words…]The issues, most recently seen first. Without filters: the unresolved ones of the last week.
collector issues show <id|url>One issue. With --markdown, the text Collector writes for an AI.
collector issues events <id|url>Its events, newest first.
collector issues event <id|url> <uuid>One event in full (--markdown too).
collector issues resolve <id|url>…Marks them resolved. Takes several.
collector issues ignore <id|url>…Marks them ignored.
collector issues reopen <id|url>…Takes them back to Unresolved.
collector issues assign <id|url> <email|me|none>Assigns someone, or nobody.

Filters for issues list: --status unresolved|resolved|ignored, --range day|week|month|all, --env, --platform elixir|javascript|node|other, --release (the release that introduced the issue) and --search, or plain words, which search the title, message and culprit. See Issues.

Logs​

CommandWhat it does
collector logs [words…]What the project's servers sent: log lines, requests and sign-ins, in one timeline, oldest at the top.

Filters: --since and --until (15m, 2h, 1d or an ISO time), --env, --server, --service, --request, --user, --ip, --account, --status 404|5xx, --path, --level (a minimum) and --type log,request,sign_in. --markdown gives Collector's text for an AI.

--follow (or -f) reads the recent records, then keeps showing new ones live, until Ctrl-C. If the connection drops, it reconnects by itself and fills the gap. See Logs.

Speed and signals​

CommandWhat it does
collector speedWeb Vitals at the 75th percentile, the slowest pages and requests, like the Speed tab.
collector speed pagesThe pages, slowest first.
collector speed page <route>One page: its measures, devices and slowest visits.
collector speed requestsThe requests pages make, slowest first.
collector speed request <method> <route>One request: the pages that make it and its slowest calls.
collector signals [<project>]Which servers and browsers report, per environment. See Signals.

speed takes --period day|week|month|quarter, --env and --device phone|tablet|desktop.

Organization and people​

CommandWhat it does
collector orgs listYour organizations and your role in each.
collector orgs show [<org>]One organization.
collector orgs edit [<org>]Renames it (--name) or changes its address (--slug). A new address changes its URLs.
collector members listThe members and their roles.
collector members invite <email>…Invites people; each gets an email with a link. --role picks the role.
collector members role <email> <member|admin|owner>Changes someone's role, with the app's rules.
collector members remove <email>Removes someone from the organization. Asks first, or --yes.
collector members leave [<org>]You leave the organization. Asks first, or --yes.
collector invitations listThe pending invitations, newest first.
collector invitations resend <id>Sends it again, with a fresh link and seven more days.
collector invitations revoke <id>Revokes it: its link stops working.
collector auditThe audit log, newest first.

Source maps and tests​

CommandWhat it does
collector upload <dir>Uploads the source maps under the directory. See Source maps.
collector testSends one test event, the way a server SDK does, and shows Collector's answer.

More​

CommandWhat it does
collector openOpens a page of the web app: the project's issues, or issue <id>, logs …, speed, settings. It prints the address too.
collector api <path>A raw request to the API, under /api/v1, signed in as you, for anything without a command of its own. -X picks the method, -f key=value adds fields.

collector completion bash|zsh|fish|powershell prints your shell's completions.

Global flags​

FlagVariable
--urlCOLLECTOR_URLWhich Collector. By default, the one you last signed in to; else app.clt.chrom.ar.
--org, --projectCOLLECTOR_ORG, COLLECTOR_PROJECTWhich project. Not needed when there's only one, or when you set one with collector use.
COLLECTOR_TOKENAn access token; it always wins over the stored one.
--jsonCollector's JSON, as is.
--lang en|esCOLLECTOR_LANGThe language of Collector's messages.
-q, --quietOnly errors and the essential result.
-v, --verboseCOLLECTOR_DEBUG=1Requests and timings on stderr; never tokens.
--no-colorNO_COLORNo colours.

Exit codes​

CodeMeans
0Done.
1Collector refused or failed: not found, not allowed, invalid data, network trouble.
2A usage mistake.
3Not signed in, a rejected or revoked token, or a read-only token that tried to change something.

upload and test use only 0, 1 and 2.