Manage Edge Delta from the Terminal with the edx CLI

Overview

edx is the Edge Delta command line interface. It provides terminal access to the full platform: Telemetry Pipelines (pipeline configurations, fleet management, live capture), observability data (logs, patterns, metrics, traces, events, monitors, dashboards), and AI Team (issues, threads, channels, teammates, connectors). A raw API escape hatch covers any endpoint that does not have a dedicated command.

edx is a single binary designed for humans, CI automation, and AI coding agents alike. Output is JSON by default, so results pipe directly into jq or into an AI agent’s context, and every command supports table, CSV, YAML, and raw output for human-friendly summaries.

The following diagram shows how edx fits between your terminal, automation, or AI agent and the Edge Delta platform:

graph LR
  A[Terminal] --> D[edx CLI]
  B[CI and automation] --> D
  C[AI coding agents] --> D
  D --> E[Edge Delta API]
  E --> F[Logs, metrics, traces, events]
  E --> G[Pipelines and fleets]
  E --> H[AI Team]

Install

Install edx with Homebrew on macOS or Linux:

brew install edgedelta/tap/edx

Alternatively, install with the Go toolchain:

go install github.com/edgedelta/edx@latest

Verify the installation:

edx version

The source is available at github.com/edgedelta/edx.

Authenticate

edx supports two authentication methods. Pick the one that matches how you run it:

• OAuth (interactive use): edx auth login opens a browser login. The access token refreshes automatically and your organization ID is derived from the token.
• API token (CI and automation): Create a token in the Edge Delta web app under Admin > My Organization > API Tokens (see Create an API Token). The Read & Write permission preset is recommended for edx. After you create the token, the Use this token section’s edx CLI tab shows a ready-made login command with the token and organization ID filled in:

edx auth login --token YOUR_API_TOKEN --org-id YOUR_ORG_ID

Credentials are saved to a profile in ~/.config/edx/config.yaml. Confirm they work with:

edx auth status

Profiles

Profiles let you switch between organizations or environments. Create a named profile with edx auth login --profile staging-org ..., list profiles with edx auth list (the default is marked with *), set the default with edx auth use <profile>, and target a profile for a single command with --profile <name>.

Environment variables

Environment variables override values from the config file, which makes them useful in CI:

Output formats

Every command accepts the same output flags:

For example, list pipelines as a compact table:

edx pipelines list --output table --columns id,tag,fleet_type,status

Conventions

These conventions apply across commands:

• Time ranges: Use --lookback with Go durations (15m, 1h, 24h), or --from and --to with ISO 8601 timestamps (2006-01-02T15:04:05.000Z).
• Pagination: Search responses include cursors; pass --cursor to continue. The default search limit is 20; raise it with --limit (maximum 1000).
• Confirmations: Destructive commands such as deploy and delete prompt before running; add --yes in non-interactive contexts.
• Queries: Search commands filter with Common Query Language (CQL) using dot-path fields, for example service.name:"api". Discover valid fields and values with edx facets keys and edx facets options before writing a query.

Install AI agent skills

edx skills installs Edge Delta skills into AI coding assistants (Claude Code, Cursor, Codex, and OpenCode) so agents know how to drive edx for log search, pipeline management, incident investigation, and more. The skills are embedded in the binary, so installed skills always match your edx version:

edx skills install          # auto-detects your assistant
edx skills install claude   # or target a platform explicitly

Add --project to install into the current repository instead of your home directory.

Update

Update to the latest release with:

edx update

Homebrew installations are upgraded through brew automatically. On interactive terminals, edx prints a one-line notice when a newer version is available (at most one check per day); set EDX_NO_UPDATE_CHECK=1 to disable it.

Troubleshooting

See Also

• edx Command Reference - Every command, grouped by domain, with key flags.
• Common Query Language (CQL) - The query syntax used by search commands.
• API Reference - The REST API that edx wraps, for direct HTTP access.
• Edge Delta MCP Server - Give MCP-capable AI clients direct tool access to Edge Delta.

In this section