apiome graph
Global options such as --base-url, --tenant and --json go before the command — see CLI reference. Exit codes are listed in Exit codes.
apiome graph
The dependency graph: declare and list what an API depends on.
apiome graph [OPTIONS] COMMAND [ARGS]...
Subcommands: declare, dependencies, export, impact.
apiome graph declare
Declare what an entity depends on (PUT …/entities/{kind}/{entity}/dependencies).
--depends-on sends the complete list of the entity's manual declarations — it does not add to them — and --clear removes them. Declarations from the entity's spec and from Backstage files are not touched. A target that does not exist is not an error: it is listed as unresolved: not-found.
apiome graph declare [OPTIONS] KIND ENTITY
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
KIND | text | yes | Entity kind: project, catalog_item, mcp_endpoint, consumer, connector. |
ENTITY | text | yes | The entity's id, or a project or catalog item's slug. |
Options
| Option | Type | Default | Required | Description |
|---|---|---|---|---|
--depends-on | text (repeatable) | SLUG[#POINTER] or KIND:ID[#POINTER] (repeatable). Replaces the entity's manual declarations: anything not listed is removed. | ||
--note | text | A note attached to every --depends-on entry. | ||
--clear | flag | Remove every manual declaration (cannot be combined with --depends-on). | ||
--format | text | table | Output: table (default) or json (the API response). |
apiome graph dependencies
List what an entity declares it depends on, from every source (GET …/dependencies).
apiome graph dependencies [OPTIONS] KIND ENTITY
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
KIND | text | yes | Entity kind: project, catalog_item, mcp_endpoint, consumer, connector. |
ENTITY | text | yes | The entity's id, or a project or catalog item's slug. |
Options
| Option | Type | Default | Required | Description |
|---|---|---|---|---|
--format | text | table | Output: table (default) or json (the API response). |
apiome graph export
Export the dependency graph as JSON or DOT (GET …/export).
Writes every edge of the workspace — or, with --entity, the edges within --depth hops of one entity — with each node's name, slug and owner team. --format dot writes a Graphviz file: apiome graph export --format dot --out graph.dot && dot -Tsvg graph.dot > graph.svg.
The export holds at most 10,000 edges; when more match, a warning is printed on stderr (and the JSON says truncated: true).
apiome graph export [OPTIONS]
Options
| Option | Type | Default | Required | Description |
|---|---|---|---|---|
--format | text | json | json (default) or dot (Graphviz). | |
--out | path | Write to this file instead of stdout. | ||
--kind | text (repeatable) | Keep edges with an end of this node kind, e.g. consumer (repeatable). | ||
--team | text | Keep edges with an end owned by this team slug. | ||
--provenance | text (repeatable) | declared, derived or runtime (repeatable; default all). | ||
--stale / --no-stale | flag | --stale | Include stale edges (default) or drop them. | |
--entity | text | Export only this entity's neighbourhood, as KIND:ID, e.g. project:<id>. | ||
--depth | integer range | 2 | Hops around --entity (1-5, default 2). |
apiome graph impact
Ask what a change affects (POST …/blast-radius).
Lists the entities that depend on the change — direct consumers, then transitive dependents — with their owner team, and how many pieces of evidence it invalidates (verification runs, contracts, deploy-gate evaluations, SDK targets, agent tools, mock packs, consumers on deprecated versions). With no --operation, --schema or --pointer the whole project changes. --format json prints the full answer, including every edge path.
apiome graph impact [OPTIONS]
Options
| Option | Type | Default | Required | Description |
|---|---|---|---|---|
--project | text | yes | The project or catalog item (slug or id) that changes. | |
--operation | text (repeatable) | An operation that changes, as METHOD /path, e.g. "GET /pets/{id}" (repeatable). | ||
--schema | text (repeatable) | A component schema that changes, by name, e.g. Pet (repeatable). | ||
--pointer | text (repeatable) | A raw JSON pointer that changes (repeatable). | ||
--kind | text | project | The changing entity's kind (default project). | |
--version | text | Version for the evidence; default latest published. | ||
--depth | integer range | 3 | Levels of dependents to walk (1-5). | |
--provenance | text (repeatable) | declared, derived or runtime (repeatable; default all). | ||
--format | text | table | Output: table (default) or json (the API response). |