Skip to main content
Version: v5.7.0

opschain entity list

Included from Basic tier

opschain entity list <parent-path> [--code <code>] [--search <text>]
[--archived=bool] [--page-size <n>] [--page-token <token>] [--all]

Lists one parent's own entities, code-ascending. The parent is a project, environment, asset or entity; only its direct child entities are listed. For a whole subtree with its entities nested at any depth, use opschain nodes list with its include-entities option instead (opschain docs cli/nodes-list). The --code, --search and --archived filters run on the server; pages ride a keyset token, so listing tens of thousands of entities stays cheap. Entities you may not read are left out of the page.

opschain entity list shop/environments/prod
PATH NAME ARCHIVED CONVERSION MAINTENANCE
/projects/shop/environments/prod/entities/orders_schema Orders schema no - -
/projects/shop/environments/prod/entities/rack_a Rack A no - -
More rows available: --page-token eyJr…

CONVERSION names how an entity left behind by a conversion was converted (promoted or demoted), - otherwise; MAINTENANCE names the reason of the window covering the entity. When more rows remain, the last line prints the token to pass back with --page-token; --all follows every page instead.

-o, --output json|yaml emits the rows as a machine document (one object per entity: id, node_path, parent_path, code, name, description, archived, created_by, created_at, updated_at, the properties and settings document ids, the conversion fields when set, and the maintenance badge when one applies).

Flags​

FlagMeaning
--code <code>Exact code match.
--search <text>Case-insensitive substring over code and name.
--archivedKeep only archived entities; --archived=false keeps only unarchived ones. Both when omitted.
--page-size <n>Rows per page (server default 100, maximum 1000). Negative values are refused.
--page-token <token>Resume from a previous page's token.
--allFollow pagination and list every page.
--filter <column>[!]=<value>Keep only rows matching the term (repeatable; terms AND). Columns are the printed table headers lowercased; * wildcards match the whole cell case-insensitively, != negates, commas mean any-of. Applied client-side to the fetched rows. Grammar: opschain docs cli.

Exit codes​

CodeMeaning
0Listed.
1The server refused — the parent is missing or unreadable, the parent kind cannot hold entities, or the server runs the embedded store.
2Usage error — an empty path, a negative page size, a bad --filter term, no server target.

See also​

  • opschain docs cli/entity-show — one entity in full.