Skip to main content

exd telemetry capabilities

Emit the machine-readable capabilities manifest: every query, its parameters, its result shape, and the diagnostics it can raise.

Synopsis

exd telemetry capabilities
[--format human|json]

Description

The capabilities manifest is the source of truth for what the binary supports. It is versioned together with the binary, so it always reflects what the CLI actually does — no drift with documentation.

Use this command for programmatic discovery: agent prompts, code generators, CI scripts that need to know which queries exist.

Use cases

  • Agent prompt grounding. An agent that writes telemetry commands first calls capabilities and embeds the structured catalog in its prompt context. This keeps agent-generated invocations accurate across binary versions:

    exd telemetry capabilities --format json | jq '.queries[] | {name, parameters: [.parameters[].name]}'
  • Pre-flight in CI. A pipeline that uses --engine duckdb should check the engine is supported on this host:

    exd telemetry capabilities --format json | jq '.engines | index("duckdb")'
  • Document generation. Render the capabilities catalog into your team's internal wiki — a "what telemetry queries can I run?" reference that updates with each binary release.

  • Sanity check after upgrade. Confirm the new binary's catalog includes a query a downstream script depends on:

    exd telemetry capabilities --format json | jq '.queries | map(.name)'

Output

Human format

A compact, readable list of every query with its parameter signature and the diagnostics it can emit. Section headers per query family.

JSON format

The full capabilities manifest schema. Top-level fields include queries, engines, sinks, diagnostics, version. Each query carries:

{
"name": "telemetry.srm",
"summary": "...",
"parameters": [
{ "name": "flag", "type": "string", "required": true, "description": "..." },
{ "name": "expected", "type": "string", "required": false, "description": "..." }
],
"result_schema": { /* JSON Schema for result.* */ },
"diagnostics": ["T001", "T002", "T011", "T012"]
}

Stability

The schema of the capabilities manifest itself is stable. The set of queries listed is NOT — new queries appear at minor versions; renames or removals are major-version events.

Exit codes

CodeCondition
0Manifest emitted.
2Bad CLI args (no other failure modes).

See also

  • Capabilities spec — normative schema.
  • run — the generic invocation form that uses these definitions.
  • The canned aliases in this directory — every one is described in the capabilities manifest under its telemetry.* query name.