edx Command Reference

This page lists every edx command, grouped by domain. For installation, authentication, output formats, and shared conventions such as time ranges and pagination, see the edx CLI overview. Run edx <command> --help for the complete flag list of any command.

The command tree covers the three Edge Delta product areas plus supporting utilities:

graph TD
  A[edx] --> B[Observability]
  A --> C[Pipelines]
  A --> D[AI Team]
  A --> E[Utilities]
  B --> B1[logs, patterns, metrics,
traces, events, monitors,
dashboards, facets, service-map]
  C --> C1[pipelines, fleet, capture,
health, ingest]
  D --> D1[ai issues, threads, channels,
agents, connectors, activity]
  E --> E1[auth, config, api,
skills, version, update]

Global flags

These flags work on every command:

Search commands share the time and paging flags --lookback (default 1h), --from, --to, --limit, --cursor, and --order.

Authentication and configuration

Manage credentials and inspect the resolved configuration:

Logs

Search and aggregate logs with CQL:

For example, find recent errors from one service:

edx logs search -q 'service.name:"checkout" AND severity_text:"error"' --lookback 4h

Patterns

Work with log patterns (clustered message signatures) for anomaly hunting:

Metrics

Discover metric names, then query them:

Metric names must be exact in metrics query; use metrics list first when unsure.

Traces and service map

Search distributed traces and view service dependencies:

Events

Search events such as pattern anomalies, monitor alerts, and Kubernetes events:

Monitors

Manage monitors and inspect their states:

Pipelines

Manage pipeline configurations through their full lifecycle: inspect, validate, save, deploy, and roll back.

A typical change follows validate, save, then deploy:

edx pipelines validate --file pipeline.yaml
edx pipelines save conf-123 --file pipeline.yaml -d "Mask PII in checkout logs"
edx pipelines deploy conf-123 --latest --wait

Processor dry runs

edx pipelines test dry-runs processors against sample data without saving or deploying anything:

Fleet

View agents and deployments across all pipelines:

Live capture

Sample real data flowing through pipeline nodes on running agents. Capture tasks are ephemeral and self-expiring, and they do not modify the pipeline. See Live Capture for the concept.

Health

Inspect pipeline component health (sources, processors, destinations):

Dashboards

Manage dashboards from the terminal:

Facets

Discover queryable fields and their observed values before writing CQL:

AI Team

Work with AI Team issues, conversations, teammates, and connectors:

Ingestion

Inspect ingestion endpoints and tokens:

Raw API

edx api <METHOD> <path> calls any Edge Delta API endpoint directly, for endpoints without a dedicated command. The {org} placeholder is substituted automatically, and org-relative shorthand paths work too:

edx api GET /v1/orgs/{org}/users
edx api GET /tokens
edx api POST /monitors --data @monitor.json

See the API Reference for available endpoints.

Skills

Install Edge Delta skills into AI coding assistants so they know how to drive edx:

Version and updates

Check and update the installed version:

See Also

• edx CLI overview - Installation, authentication, output formats, and conventions.
• Common Query Language (CQL) - Query syntax for the search commands.
• Live Capture - How live capture sampling works.
• API Reference - The REST API behind these commands.