Use the
CLI to manage your organization's Software Catalog, Scorecards, and Engineering data from the command line. All commands communicate with the DX web API and require authentication.
Run
to see all top-level commands. Run
to see usage for any command:
All commands accept
to return machine-readable JSON instead of human-readable output.
Before using a
subcommand for the first time, verify that you are authenticated:
If this returns an error or shows that you are not logged in, stop and ask the user to login interactively with
, or non-interactively with
.
Entity — A record in the Software Catalog representing a service, team, library, or any other thing tracked by your organization. Each entity has an
(a unique slug), a
, optional
,
,
,
, and a map of typed
.
Entity Type — The schema for a category of entities (e.g.
,
). An entity type defines which
and
entities of that type carry.
Property — A typed field defined on an entity type. Properties have identifiers and types such as
,
,
,
,
,
,
,
,
,
, and others. When setting properties with
, use
syntax; for
and
types, values are comma-separated.
Scorecard — A health-tracking framework that evaluates entities against a set of checks. Scorecards are either
-based (entities are ranked across named levels like Bronze/Silver/Gold) or
-based (entities accumulate points from checks). To see how a specific entity is currently performing across all scorecards, use
dx catalog entities scorecards <identifier>
.
Check — A single SQL-based rule inside a scorecard. The SQL query returns a
column (
,
, or
) for each entity.
Initiative — A time-boxed project that groups failing scorecard checks into actionable tasks for teams. Tasks for a given entity can be fetched with
dx catalog entities tasks <identifier>
.