Skip to content

Commit 19b8c99

Browse files
committed
Merge branch 'moe/temporal-agent-cli' into moe/temporal-agent-cli-examples
2 parents ea887a0 + 6a26e4d commit 19b8c99

7 files changed

Lines changed: 278 additions & 366 deletions

File tree

README.md

Lines changed: 19 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -50,45 +50,42 @@ Reference [the documentation](https://docs.temporal.io/cli) for detailed usage i
5050

5151
The CLI includes workflow commands optimized for AI agents, LLM tooling, and automated debugging:
5252

53-
### New Commands
54-
55-
- **`temporal workflow failures`** - List recent workflow failures with auto-traversed root cause
56-
- **`temporal workflow diagnose`** - Trace a workflow through its child chain to the deepest failure
57-
- **`temporal tool-spec`** - Output tool specifications for AI agent frameworks
58-
5953
### Enhanced Commands
6054

55+
- **`temporal workflow list --failed`** - List recent workflow failures with auto-traversed root cause
56+
- **`temporal workflow describe --trace-root-cause`** - Trace a workflow through its child chain to the deepest failure
6157
- **`temporal workflow show --compact`** - Show a compact event timeline
6258
- **`temporal workflow show --format mermaid`** - Generate a sequence diagram
6359
- **`temporal workflow describe --pending`** - Show pending activities, children, and Nexus operations
6460
- **`temporal workflow describe --format mermaid`** - Generate a state diagram
61+
- **`temporal tool-spec`** - Output tool specifications for AI agent frameworks
6562

6663
### Examples
6764

6865
```bash
6966
# List failures from the last hour with automatic chain traversal
70-
temporal workflow failures --namespace prod --since 1h --follow-children
67+
temporal workflow list --failed --namespace prod --since 1h --follow-children
7168

7269
# Filter failures by error message (case-insensitive)
73-
temporal workflow failures --namespace prod --since 1h --error-contains "timeout"
70+
temporal workflow list --failed --namespace prod --since 1h --error-contains "timeout"
7471

7572
# Show only leaf failures (de-duplicate parent/child chains)
76-
temporal workflow failures --namespace prod --since 1h --follow-children --leaf-only
73+
temporal workflow list --failed --namespace prod --since 1h --follow-children --leaf-only
7774

7875
# Compact error messages (strip wrapper context, show core error)
79-
temporal workflow failures --namespace prod --since 1h --follow-children --compact-errors
76+
temporal workflow list --failed --namespace prod --since 1h --follow-children --compact-errors
8077

8178
# Combine leaf-only and compact-errors for cleanest output
82-
temporal workflow failures --namespace prod --since 1h --follow-children --leaf-only --compact-errors
79+
temporal workflow list --failed --namespace prod --since 1h --follow-children --leaf-only --compact-errors
8380

8481
# Group failures by error type for quick summary
85-
temporal workflow failures --namespace prod --since 24h --follow-children --compact-errors --group-by error
82+
temporal workflow list --failed --namespace prod --since 24h --follow-children --compact-errors --group-by error
8683

8784
# Group failures by namespace to see which services are failing
88-
temporal workflow failures --namespace prod --since 24h --follow-children --group-by namespace
85+
temporal workflow list --failed --namespace prod --since 24h --follow-children --group-by namespace
8986

9087
# Trace a workflow to find the deepest failure in the chain
91-
temporal workflow diagnose --workflow-id order-123 --namespace prod
88+
temporal workflow describe --trace-root-cause --workflow-id order-123 --namespace prod
9289

9390
# Get a compact timeline of workflow events
9491
temporal workflow show --workflow-id order-123 --namespace prod --compact
@@ -98,7 +95,7 @@ temporal workflow describe --workflow-id order-123 --namespace prod --pending
9895

9996
# Cross-namespace traversal (Nexus/child workflows in other namespaces)
10097
TEMPORAL_API_KEY_FINANCE_NS="$FINANCE_KEY" \
101-
temporal workflow diagnose --workflow-id order-123 --namespace commerce-ns \
98+
temporal workflow describe --trace-root-cause --workflow-id order-123 --namespace commerce-ns \
10299
--follow-namespaces finance-ns
103100
```
104101

@@ -122,12 +119,12 @@ export TEMPORAL_API_KEY="primary-ns-key"
122119
export TEMPORAL_API_KEY_FINANCE_NS="finance-ns-key"
123120
export TEMPORAL_API_KEY_LOGISTICS_NS="logistics-ns-key"
124121

125-
# Now diagnose can follow Nexus operations and child workflows across namespaces
126-
temporal workflow diagnose --workflow-id order-123 --namespace commerce-ns \
122+
# Trace root cause across namespaces (follows Nexus operations and child workflows)
123+
temporal workflow describe --trace-root-cause --workflow-id order-123 --namespace commerce-ns \
127124
--follow-namespaces finance-ns,logistics-ns
128125

129-
# For failures command, use --follow-children with --follow-namespaces
130-
temporal workflow failures --namespace commerce-ns --since 1h \
126+
# List failures with cross-namespace traversal
127+
temporal workflow list --failed --namespace commerce-ns --since 1h \
131128
--follow-children --follow-namespaces finance-ns,logistics-ns \
132129
--leaf-only --compact-errors
133130
```
@@ -138,7 +135,7 @@ Commands support `--format mermaid` to generate visual diagrams:
138135

139136
```bash
140137
# Visualize workflow chain as a flowchart
141-
temporal workflow diagnose --workflow-id order-123 --namespace prod --format mermaid
138+
temporal workflow describe --trace-root-cause --workflow-id order-123 --namespace prod --format mermaid
142139

143140
# Visualize timeline as a sequence diagram
144141
temporal workflow show --workflow-id order-123 --namespace prod --format mermaid
@@ -147,10 +144,10 @@ temporal workflow show --workflow-id order-123 --namespace prod --format mermaid
147144
temporal workflow describe --workflow-id order-123 --namespace prod --pending --format mermaid
148145

149146
# Visualize failures as a pie chart (when grouped)
150-
temporal workflow failures --namespace prod --since 1h --group-by error --format mermaid
147+
temporal workflow list --failed --namespace prod --since 1h --group-by error --format mermaid
151148

152149
# Visualize failures as a flowchart (when not grouped)
153-
temporal workflow failures --namespace prod --since 1h --follow-children --format mermaid
150+
temporal workflow list --failed --namespace prod --since 1h --follow-children --format mermaid
154151
```
155152

156153
The mermaid output renders directly in:

0 commit comments

Comments
 (0)