@@ -6,28 +6,28 @@ When debugging Temporal workflows, use the `temporal workflow` CLI commands inst
66
77### Find Failures
88``` bash
9- temporal workflow list --failed --since 1h --format json
10- temporal workflow list --failed --since 1h --follow-children --leaf-only --compact-errors --format json
11- temporal workflow list --failed --since 1h --group-by error --format json
9+ temporal workflow list --failed --since 1h --output json
10+ temporal workflow list --failed --since 1h --follow-children --leaf-only --compact-errors --output json
11+ temporal workflow list --failed --since 1h --group-by error --output json
1212```
1313
1414### Trace Workflow Chain
1515``` bash
16- temporal workflow describe --trace-root-cause --workflow-id < id> --format json
17- temporal workflow describe --trace-root-cause --workflow-id < id> --format mermaid
16+ temporal workflow describe --trace-root-cause --workflow-id < id> --output json
17+ temporal workflow describe --trace-root-cause --workflow-id < id> --output mermaid
1818```
1919
2020### Get Timeline
2121``` bash
22- temporal workflow show --compact --workflow-id < id> --format json
23- temporal workflow show --compact --workflow-id < id> --compact --format json
24- temporal workflow show --compact --workflow-id < id> --format mermaid
22+ temporal workflow show --compact --workflow-id < id> --output json
23+ temporal workflow show --compact --workflow-id < id> --compact --output json
24+ temporal workflow show --compact --workflow-id < id> --output mermaid
2525```
2626
2727### Check State
2828``` bash
29- temporal workflow describe --pending --workflow-id < id> --format json
30- temporal workflow describe --pending --workflow-id < id> --format mermaid
29+ temporal workflow describe --pending --workflow-id < id> --output json
30+ temporal workflow describe --pending --workflow-id < id> --output mermaid
3131```
3232
3333## Key Flags
@@ -36,21 +36,21 @@ temporal workflow describe --pending --workflow-id <id> --format mermaid
3636- ` --leaf-only ` - Show only leaf failures (de-duplicate chains)
3737- ` --compact-errors ` - Strip wrapper context, show core error
3838- ` --group-by error|namespace|type|status ` - Aggregate failures
39- - ` --format mermaid ` - Output visual diagrams
40- - ` --format json ` - Structured JSON output
39+ - ` --output mermaid ` - Output visual diagrams
40+ - ` --output json ` - Structured JSON output
4141
4242## Visualization
4343
44- Use ` --format mermaid ` to generate diagrams:
45- - ` trace --format mermaid ` → Flowchart of workflow chain
46- - ` timeline --format mermaid ` → Sequence diagram of events
47- - ` state --format mermaid ` → State diagram with pending work
48- - ` failures --group-by error --format mermaid ` → Pie chart
44+ Use ` --output mermaid ` to generate diagrams:
45+ - ` trace --output mermaid ` → Flowchart of workflow chain
46+ - ` timeline --output mermaid ` → Sequence diagram of events
47+ - ` state --output mermaid ` → State diagram with pending work
48+ - ` failures --group-by error --output mermaid ` → Pie chart
4949
5050## Debugging Workflow
5151
52521 . Start with ` workflow diagnose ` to see the chain and root cause
53- 2 . Use ` --format mermaid ` to visualize if complex
53+ 2 . Use ` --output mermaid ` to visualize if complex
54543 . Use ` workflow failures --leaf-only ` to see actual failures
55554 . Use ` workflow describe --pending ` to check pending work on running workflows
56565 . Use ` --group-by ` to find patterns in multiple failures
@@ -60,8 +60,8 @@ Use `--format mermaid` to generate diagrams:
6060User: "The order workflow failed"
6161
6262You should:
63- 1 . Run ` temporal workflow describe --trace-root-cause --workflow-id order-123 --format json `
64- 2 . If complex, add ` --format mermaid ` for visual
63+ 1 . Run ` temporal workflow describe --trace-root-cause --workflow-id order-123 --output json `
64+ 2 . If complex, add ` --output mermaid ` for visual
65653 . Identify the leaf failure and root cause
66664 . Explain what went wrong
67675 . Suggest a fix
0 commit comments