Skip to main content

exd telemetry run

Run a built-in telemetry query by name. The generic alternative to the canned aliases (summary, srm, rules, …).

Synopsis​

exd telemetry run <name> [--<param> <value>]...
    [common flags]

See common flags.

Description​

<name> is a fully qualified query name from the built-in catalog — telemetry.summary, telemetry.srm, etc. Parameters declared in the query's parameter list are passed as --<param-name> <value> flags.

This command exists for explicit, scriptable invocations. The canned aliases are sugar over run:

exd telemetry summary --flag X       # convenience alias
exd telemetry run telemetry.summary --flag X    # equivalent

Agents and automation SHOULD prefer run plus capabilities discovery: the canned aliases may add new flags at minor versions; run's parameter contract is published in the capabilities manifest, so generated invocations stay accurate across versions.

Deferred: the user-defined-query resolution path (running an arbitrary <queries-root>/<name>.toml query) is deferred indefinitely. Until that ships, <name> MUST be one of the built-in telemetry.* queries.

Use cases​

  • Discover-then-invoke agent flow.

    exd telemetry capabilities --format json | jq '.queries[] | {name, parameters}'
    exd telemetry run telemetry.srm --flag onboarding-banner --since 24h

  • Lock down which exact query a CI step runs. Refer to the query by its fully qualified name so a rename of a canned alias doesn't silently change the test:

    exd telemetry run telemetry.rules --flag onboarding-banner --since 1h --fail-on-error

Arguments​

ArgumentNotes
<name> (positional)Required. Fully qualified built-in query name: telemetry.summary, telemetry.srm, telemetry.rules, telemetry.user, telemetry.coverage, telemetry.dead_flags, telemetry.version_skew, telemetry.contexts, telemetry.simulate.

Parameter flags are the same as the corresponding canned subcommand's flag set. Missing required parameters → exit 2.

Output​

Identical shape to the canned aliases. result.query carries the fully qualified name ("telemetry.srm") regardless of which entry point you used.

Exit codes​

See telemetry exit codes.

See also​