CLI Reference

Complete reference for all Epilogue Tracker commands.

Global Options

These options work with any command:

Option	Description
--help	Show help message
--version	Show version number
--json	Output in JSON format
--verbose	Show detailed output
--quiet	Suppress non-essential output

Commands

Command	Description
create	Create a new entity
list	List entities (tree view or by type)
show	Show entity details
update	Update an entity
remove	Remove an entity
close	Mark goal/interaction as closed
reopen	Reopen a closed goal/interaction
validate	Check model integrity

Entity Types

Type	Description	Has Status
actor	User role	No
goal	User objective	Yes
interaction	Task supporting a goal	Yes
journey	Sequence of interactions	No

Status Filtering

Goals and interactions have a status (open or closed). List commands filter by status:

Option	Description
(default)	Show only open items
--closed	Show only closed items
--all	Show all items regardless of status

Data Storage

Data is stored in .et/ at the project root:

.et/
├── actors/
│   └── customer.json
├── goals/
│   └── checkout.json
├── interactions/
│   └── add_to_cart.json
└── journeys/
    └── checkout_flow.json

Each entity is a separate JSON file, making it easy to:

• Version control with git
• Review changes in PRs
• Manually edit if needed

Exit Codes

Code	Meaning
0	Success
1	Error (invalid input, entity not found, validation failed)

Examples

# View all outstanding work
et list

# Create a complete workflow
et create actor --id "customer" --name "Customer" --description "Online shopper"
et create goal --id "checkout" --description "Complete purchase" --actor "customer"
et create interaction --id "add_to_cart" --description "Add to cart" --goal "checkout"
et create journey --id "flow" --actor "customer" --goal "checkout" --steps "add_to_cart"

# List and filter
et list actors
et list goals --actor customer
et list interactions --goal checkout

# Mark work complete
et close goal checkout
et close interaction add_to_cart

# View closed work
et list --closed

# Validate
et validate --json

# Clean up
et remove interaction add_to_cart --force