You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 8a6bd23
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: apps/docs/content/docs/cli/logs.mdx
+3-1Lines changed: 3 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,8 +31,10 @@ sim logs get <runId> [options]
31
31
32
32
| Option | Required | Description |
33
33
| --- | --- | --- |
34
+
|`--include-workflow-state`| No | Include the saved workflow snapshot. Set false to avoid loading and returning block configuration when inspecting a run. Other run fields are unchanged. |
35
+
|`--no-include-workflow-state`| No | Send --include-workflow-state as false. |
34
36
|`--trace`| No | Show expanded trace spans with inputs, outputs, errors, timing, and cost. |
35
-
|`--summary`| No | Show bounded run diagnostics and the explicit application outcome; omit binary content. |
37
+
|`--summary`| No | Show bounded run diagnostics and final output; omit binary content and the workflow snapshot. |
Copy file name to clipboardExpand all lines: apps/docs/content/docs/cli/reference.mdx
+5-3Lines changed: 5 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2749,8 +2749,10 @@ sim logs get <runId> [options]
2749
2749
2750
2750
| Option | Required | Description |
2751
2751
| --- | --- | --- |
2752
+
|`--include-workflow-state`| No | Include the saved workflow snapshot. Set false to avoid loading and returning block configuration when inspecting a run. Other run fields are unchanged. |
2753
+
|`--no-include-workflow-state`| No | Send --include-workflow-state as false. |
2752
2754
|`--trace`| No | Show expanded trace spans with inputs, outputs, errors, timing, and cost. |
2753
-
|`--summary`| No | Show bounded run diagnostics and the explicit application outcome; omit binary content. |
2755
+
|`--summary`| No | Show bounded run diagnostics and final output; omit binary content and the workflow snapshot. |
|`--dry-run`| No | Validate and lint without writing, auditing, or notifying collaborators. Returns the same validation, preparation warnings, lint findings, and ID-ownership conflicts (`409`) as a committed write. `needsRedeployment` describes the pre-write state. For semantic operations, `mintedBlockIds` is empty; `previewBlockIds` contains provisional IDs with a warning, since committing mints new IDs. |
6122
6124
|`--no-dry-run`| No | Send --dry-run as false. |
6123
-
|`--operations <json\|@file>`|Yes| Edits to apply, in a single batch, keyed by operation_type: [{"operation_type":"add","block_id":"my-fn","params":{"type":"function","name":"My Fn","inputs":{"code":"return {ok:true}"}}},{"operation_type":"edit","block_id":"<uuid>","params":{"name":"Renamed","connections":{"success":"my-fn"}}},{"operation_type":"delete","block_id":"<uuid>"}]. Also extract_from_subflow, whose params carry {"subflowId":"<loop-id>"}, and insert_into_subflow, which creates a block and so takes an add’s params plus that subflowId (JSON, or @path / @- to read a file or stdin). |
6125
+
|`--operations <json\|@file>`|No| Edits to apply, in a single batch, keyed by operation_type: [{"operation_type":"add","block_id":"my-fn","params":{"type":"function","name":"My Fn","inputs":{"code":"return {ok:true}"}}},{"operation_type":"edit","block_id":"<uuid>","params":{"name":"Renamed","connections":{"success":"my-fn"}}},{"operation_type":"delete","block_id":"<uuid>"}]. Also extract_from_subflow, whose params carry {"subflowId":"<loop-id>"}, and insert_into_subflow, which creates a block and so takes an add’s params plus that subflowId (JSON, or @path / @- to read a file or stdin). |
6124
6126
|`--atomic`| No | Fail the whole batch when any operation is declined or any block input would be dropped. The default applies what it can and reports the rest in `skipped` and `inputValidationErrors`; `true` writes nothing and answers `409` instead. |
6125
6127
|`--no-atomic`| No | Send --atomic as false. |
6126
6128
|`--layout <value>`| No | Whether to reposition blocks the batch touched. `targeted` (default) nudges only the affected subgraph; `none` leaves every position exactly as supplied. Accepted values: `targeted`, `none`. |
Copy file name to clipboardExpand all lines: apps/docs/content/docs/cli/workflows.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -64,7 +64,7 @@ Apply Workflow Operations (OAuth login or personal API key required)
64
64
| --- | --- | --- |
65
65
|`--dry-run`| No | Validate and lint without writing, auditing, or notifying collaborators. Returns the same validation, preparation warnings, lint findings, and ID-ownership conflicts (`409`) as a committed write. `needsRedeployment` describes the pre-write state. For semantic operations, `mintedBlockIds` is empty; `previewBlockIds` contains provisional IDs with a warning, since committing mints new IDs. |
66
66
|`--no-dry-run`| No | Send --dry-run as false. |
67
-
|`--operations <json\|@file>`|Yes| Edits to apply, in a single batch, keyed by operation_type: [{"operation_type":"add","block_id":"my-fn","params":{"type":"function","name":"My Fn","inputs":{"code":"return {ok:true}"}}},{"operation_type":"edit","block_id":"<uuid>","params":{"name":"Renamed","connections":{"success":"my-fn"}}},{"operation_type":"delete","block_id":"<uuid>"}]. Also extract_from_subflow, whose params carry {"subflowId":"<loop-id>"}, and insert_into_subflow, which creates a block and so takes an add’s params plus that subflowId (JSON, or @path / @- to read a file or stdin). |
67
+
|`--operations <json\|@file>`|No| Edits to apply, in a single batch, keyed by operation_type: [{"operation_type":"add","block_id":"my-fn","params":{"type":"function","name":"My Fn","inputs":{"code":"return {ok:true}"}}},{"operation_type":"edit","block_id":"<uuid>","params":{"name":"Renamed","connections":{"success":"my-fn"}}},{"operation_type":"delete","block_id":"<uuid>"}]. Also extract_from_subflow, whose params carry {"subflowId":"<loop-id>"}, and insert_into_subflow, which creates a block and so takes an add’s params plus that subflowId (JSON, or @path / @- to read a file or stdin). |
68
68
|`--atomic`| No | Fail the whole batch when any operation is declined or any block input would be dropped. The default applies what it can and reports the rest in `skipped` and `inputValidationErrors`; `true` writes nothing and answers `409` instead. |
69
69
|`--no-atomic`| No | Send --atomic as false. |
70
70
|`--layout <value>`| No | Whether to reposition blocks the batch touched. `targeted` (default) nudges only the affected subgraph; `none` leaves every position exactly as supplied. Accepted values: `targeted`, `none`. |
Copy file name to clipboardExpand all lines: apps/docs/content/docs/mcp/index.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -145,7 +145,7 @@ named MCP tool for every operation. Use `search_operations` and
145
145
| Edit an existing workflow |[Workflow commands](/cli/workflows)|`getWorkflowState` and `replaceWorkflowState`| Invokes the deployed workflow; does not expose the workspace editing API |
146
146
| Deploy a workflow |[Workflow commands](/cli/workflows)|`deployWorkflow`| Configure the deployment in Sim or through CLI/API/hosted MCP |
147
147
| Invoke a workflow |[Workflow commands](/cli/workflows)|`executeWorkflow`; async execution is deployment-only, while manual runs are synchronous or streamed through CLI/API | The selected workflows appear as their own tools |
148
-
| Preview a partial retry |[Agent workflow guide](/cli/agent-workflows)|`previewWorkflowRunFromBlock` reports candidate reruns and cached-output availability without executing | Not part of the deployed workflow tool interface |
148
+
| Preview a partial retry |[Workflow operations guide](/cli/workflow-operations)|`previewWorkflowRunFromBlock` reports candidate reruns and cached-output availability without executing | Not part of the deployed workflow tool interface |
149
149
| Inspect runs and outputs |[Workflow commands](/cli/workflows)|`listWorkflowRuns`, `getWorkflowRun`, and other discovered run operations | Returns the invoked workflow's result |
150
150
| Search workspace knowledge |[Knowledge commands](/cli/knowledge)|`searchKnowledge`| Only if the workflow performs that search |
151
151
| Search live organization sources | Use the dedicated [Search MCP](/search/mcp) connection | Separate endpoint with `search` and `read_document` tools | Only if the workflow performs that search |
Copy file name to clipboardExpand all lines: apps/docs/openapi-v2-logs.json
+11-1Lines changed: 11 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -383,6 +383,16 @@
383
383
"pattern": "^[A-Za-z0-9._:-]+$",
384
384
"description": "Unique workflow run identifier."
385
385
}
386
+
},
387
+
{
388
+
"name": "includeWorkflowState",
389
+
"in": "query",
390
+
"required": false,
391
+
"description": "Include the saved workflow snapshot. Set false to avoid loading and returning block configuration when inspecting a run. Other run fields are unchanged.",
392
+
"schema": {
393
+
"description": "Include the saved workflow snapshot. Set false to avoid loading and returning block configuration when inspecting a run. Other run fields are unchanged.",
394
+
"type": "boolean"
395
+
}
386
396
}
387
397
],
388
398
"responses": {
@@ -1602,7 +1612,7 @@
1602
1612
"type": "null"
1603
1613
}
1604
1614
],
1605
-
"description": "Workflow graph captured for the run, or null if unavailable. Sensitive values are redacted to null; environment-variable references may be preserved."
1615
+
"description": "Credential-redacted workflow snapshot, or null when unavailable or includeWorkflowState=false."
0 commit comments