Skip to content

update

Update an existing entity's fields.

Usage

bash
et update <type> <id> [options]

Common Tag & Metadata Options

All entity types support these tag and metadata operations:

OptionDescription
--tagsReplace all tags with this list
--add-tagsAdd tags to existing
--remove-tagsRemove specific tags
--metaAdd/update metadata entry (repeatable)
--meta-jsonAdd/update metadata via JSON object
--remove-metaRemove metadata key (repeatable)

Actor

bash
et update actor <id> [--name <name>] [--description <description>] [--goals <goals>] [tag/meta options]
OptionDescription
--nameUpdate name
--descriptionUpdate description
--goalsUpdate goals (comma-separated IDs)

Example:

bash
et update actor customer --description "Updated description"
et update actor customer --goals "checkout,browse,support"

Tag operations:

bash
# Add tags
et update actor admin --add-tags "verified,active"

# Remove tags
et update actor admin --remove-tags "legacy"

# Replace all tags
et update actor admin --tags "production"

Metadata operations:

bash
# Add/update metadata
et update actor admin --meta "login_hint=admin@example.com" --meta "role=superuser"

# Remove metadata keys
et update actor admin --remove-meta "old_key"

# Update via JSON
et update actor admin --meta-json '{"department":"Engineering"}'

Goal

bash
et update goal <id> [--name <name>] [--description <description>] [--actor <actor>] [--success-criteria <criteria>] [tag/meta options]
OptionDescription
--nameUpdate display name
--descriptionUpdate description
--actorUpdate assigned actor
--success-criteriaUpdate success criteria

Example:

bash
et update goal checkout --name "Complete Purchase"
et update goal checkout --actor customer
et update goal checkout --success-criteria "Order placed and confirmed within 5 minutes"

Mark as verified (using tags):

bash
et update goal export_data --add-tags "verified" --remove-tags "unverified"

Interaction

bash
et update interaction <id> [--name <name>] [--description <description>] [--performed-by <actor>] [--goal <goal>] [--goals <goal1,goal2>] [tag/meta options]
OptionDescription
--nameUpdate display name
--descriptionUpdate description
--performed-byUpdate performing actor
--goalUpdate to single supported goal
--goalsUpdate to multiple supported goals (comma-separated)

Example:

bash
et update interaction add_to_cart --name "Add to Cart"
et update interaction add_to_cart --goal complete_purchase
et update interaction add_to_cart --description "Add items to cart with quantity"

# Update to support multiple goals
et update interaction export_data --goals "export_data,backup_data"

Track source system (using metadata):

bash
et update interaction export_csv --meta "source=legacy" --meta "verified_by=agent"

Journey

bash
et update journey <id> [--actor <actor>] [--goal <goal>] [--steps <steps>] [--narrative <narrative>] [tag/meta options]
OptionDescription
--actorUpdate protagonist (who benefits from completing the journey)
--goalUpdate goal
--stepsUpdate steps (comma-separated IDs; steps can be performed by any actor)
--narrativeUpdate narrative

Example:

bash
et update journey checkout_flow --steps "browse,search,add_to_cart,checkout"
et update journey checkout_flow --narrative "Updated journey description"

Mark journey as documented:

bash
et update journey checkout_flow --add-tags "documented,tested"

Output

Default:

Goal 'checkout' updated: actor, success_criteria

With --json:

json
{
  "success": true,
  "message": "Goal 'checkout' updated",
  "data": {
    "id": "checkout",
    "description": "Complete purchase",
    "actor": "customer",
    "success_criteria": "Order placed and confirmed within 5 minutes",
    "tags": ["verified", "production"],
    "meta": {
      "source": "legacy",
      "verified_by": "agent"
    },
    "created_at": "2024-01-15T10:30:00.000Z",
    "updated_at": "2024-01-15T11:45:00.000Z"
  }
}

Errors

  • Entity not found: Error: Goal 'unknown' not found
  • No updates provided: Error: No updates provided

Work matters when it helps real people achieve their goals.