Skip to content

Commit 81666bf

Browse files
committed
fix(docs): clarify run summary defaults and binary omission
1 parent 3596de8 commit 81666bf

1 file changed

Lines changed: 8 additions & 8 deletions

File tree

‎apps/docs/content/docs/cli/output.mdx‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -78,14 +78,14 @@ sim --output json logs get "$RUN_ID" --summary
7878
The summary includes execution status, the workflow's existing `finalOutput`,
7979
recorded failures (including handled errors), compact failing inputs and outputs,
8080
observed block statuses, and file metadata. It bounds trace traversal and field
81-
sizes, reports `truncated` when detail is omitted, and omits binary fields and data
82-
URLs. Use `--trace` or [output selectors](/cli/scripting#selecting-workflow-output)
83-
when you need more detail.
84-
85-
`--summary` asks the server to omit the saved workflow snapshot, then formats the
86-
remaining authorized log response locally; it still loads the trace. To omit
87-
only the snapshot, use `--no-include-workflow-state`. HTTP and hosted MCP callers
88-
can set `includeWorkflowState=false` on the log read.
81+
sizes, reports `truncated` when detail is omitted, and omits recognized binary
82+
fields and base64 data URLs. Use `--trace` or
83+
[output selectors](/cli/scripting#selecting-workflow-output) when you need more detail.
84+
85+
By default, `--summary` asks the server to omit the saved workflow snapshot, then
86+
formats the remaining authorized log response locally; it still loads the trace.
87+
To omit only the snapshot, use `--no-include-workflow-state`. HTTP and hosted MCP
88+
callers can set `includeWorkflowState=false` on the log read.
8989

9090
Execution status describes the run, not the quality of its output or whether an
9191
external delivery succeeded. Inspect `finalOutput` and recorded tool failures

0 commit comments

Comments
 (0)