list
List entities, with optional filtering by type and status.
Usage
bash
et list [type] [options]Tree View (No Type)
When called without a type, shows a hierarchical view of all work:
bash
et list [--closed] [--all] [--json]Example:
bash
et listOutput:
Customer [customer]
- Complete purchase successfully
goal: checkout
- Add products to shopping cart
interaction: add_to_cart
- Complete checkout process
interaction: complete_checkout
Admin [admin]
- Manage system users and permissions
goal: manage_users
2 actor(s), 2 open goal(s), 2 open interaction(s)Options
| Option | Description |
|---|---|
--format <format> | Output format: table (default) or json |
--json | Shorthand for --format json (tree view only) |
--actor <id> | Filter by actor (goals, journeys) |
--goal <id> | Filter by goal (interactions, journeys) |
--closed | Show only closed items (default: open only) |
--all | Show all items regardless of status |
--tag <tags> | Filter by tags (comma-separated for OR matching) |
Status Filtering
By default, list commands show only open items. Use status flags to change this:
bash
# Show only open items (default)
et list goals
# Show only closed items
et list goals --closed
# Show all items with status indicator
et list goals --allWhen using --all, a status column is displayed:
ID Description Actor Status
-------------------- --------------------------------------------- --------------- --------
checkout Complete purchase successfully customer open
old_feature Legacy feature (deprecated) customer closedTag Filtering
Use --tag to filter entities by tags. Multiple tags are comma-separated and use OR matching (entities with any of the specified tags):
bash
# Filter by single tag
et list goals --tag legacy
# Filter by multiple tags (OR matching - items with "legacy" OR "unverified")
et list goals --tag "legacy,unverified"
# Combine with other filters
et list interactions --goal checkout --tag "verified"
# Tag filtering in tree view
et list --tag legacyExample output when filtering by tag:
ID Description Actor Tags
-------------------- --------------------------------------------- --------------- -------------
export_csv Export data as CSV file admin legacy, verified
export_pdf Export data as PDF file admin legacy
Total: 2 open goal(s)Actors
bash
et list actors [--format json] [--tag <tags>]Example:
bash
et list actors
# Filter by tag
et list actors --tag internalOutput:
ID Name Description
-------------------- -------------------- ----------------------------------------
customer Customer An online shopper looking to purchase...
admin Administrator System administrator managing users...
Total: 2 actor(s)Goals
bash
et list goals [--format json] [--actor <id>] [--closed] [--all] [--tag <tags>]Examples:
bash
# All open goals
et list goals
# All closed goals
et list goals --closed
# All goals regardless of status
et list goals --all
# Goals for a specific actor
et list goals --actor customer
# Filter by tag
et list goals --tag legacy
# Combine filters
et list goals --actor admin --tag "unverified"
# JSON format
et list goals --format jsonInteractions
bash
et list interactions [--format json] [--goal <id>] [--closed] [--all] [--tag <tags>]Examples:
bash
# All open interactions
et list interactions
# Interactions supporting a specific goal
et list interactions --goal checkout
# Closed interactions only
et list interactions --closed
# Filter by tag
et list interactions --tag verified
# Find unverified interactions for a specific goal
et list interactions --goal export_data --tag unverified
# JSON format
et list interactions --format jsonJourneys
bash
et list journeys [--format json] [--actor <id>] [--goal <id>] [--tag <tags>]Examples:
bash
# All journeys
et list journeys
# Journeys for a specific actor
et list journeys --actor customer
# Journeys for a specific goal
et list journeys --goal checkout
# Filter by tag
et list journeys --tag documented
# JSON format
et list journeys --format jsonJSON Output
All list commands support JSON output:
bash
# Tree view as JSON
et list --json
# Typed list as JSON
et list goals --format jsonTree view JSON structure:
json
[
{
"type": "actor",
"id": "customer",
"description": "Customer",
"tags": ["external"],
"children": [
{
"type": "goal",
"id": "checkout",
"description": "Complete purchase successfully",
"status": "open",
"tags": ["verified", "production"],
"children": [...]
}
]
}
]Empty Results
When no entities match:
bash
et list goals --closedNo closed goals found.