Skip to content

fix(cli): expose pagination cursors and fetch complete inventories #7590

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
TheodoreSpeaks merged 2 commits into from
Sep 8, 2026
Merged

fix(cli): expose pagination cursors and fetch complete inventories #7590

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8f1f22c
fix(cli): expose pagination cursors and fetch complete inventories
TheodoreSpeaks Sep 8, 2026
1dd8165
fix(cli): reject pagination cursor cycles
TheodoreSpeaks Sep 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions apps/docs/content/docs/cli/audit-logs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ List Audit Logs (OAuth login or personal API key required)
| `--include-departed` | No | Include actions by users who have left the organization. |
| `--no-include-departed` | No | Send --include-departed as false. |
| `--limit <n>` | No | Maximum items to return (0 for everything). Defaults to `100`. |
| `--cursor <value>` | No | Continue from nextCursor returned by a previous result. |
| `--organization <value>` | No | Organization ID; defaults to your only organization, and is required when your account belongs to more than one (OAuth login or personal API key required). |
| `--actor-email <value>` | No | Filter by actor email address. |
| `--all-workspaces` | No | Do not filter to the configured workspace (OAuth login or personal API key required for account-wide access). |
Expand Down
1 change: 1 addition & 0 deletions apps/docs/content/docs/cli/billing.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ List credit usage events (an OAuth login or personal API key reports only your e
| `--start-date <value>` | No | Custom period start (ISO 8601). |
| `--end-date <value>` | No | Custom period end (ISO 8601). |
| `--limit <n>` | No | Maximum items to return (0 for everything). Defaults to `100`. |
| `--cursor <value>` | No | Continue from nextCursor returned by a previous result. |
| `--all-workspaces` | No | Do not filter to the configured workspace (OAuth login or personal API key required for account-wide access). |

</CommandTable>
2 changes: 1 addition & 1 deletion apps/docs/content/docs/cli/blocks.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,6 @@ sim blocks list [options]
| `--source <value>` | No | Restrict to built-in blocks or this workspace's deployed custom blocks. Accepted values: `builtin`, `custom`. |
| `--sort-by <value>` | No | Field used to sort the result. Sorting by `name` is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: `id`, `name`, `category`. |
| `--sort-order <value>` | No | Sort direction. Accepted values: `asc`, `desc`. |
| `--limit <n>` | No | Maximum items to return (0 for everything). Defaults to `100`. |
| `--limit <n>` | No | Maximum items to return (0 for everything). Defaults to `0`. |

</CommandTable>
2 changes: 1 addition & 1 deletion apps/docs/content/docs/cli/chat-deployments.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,6 @@ sim chat-deployments list [options]
| `--no-is-active` | No | Send --is-active as false. |
| `--sort-by <value>` | No | Field used to sort the result. Accepted values: `identifier`, `createdAt`, `updatedAt`. |
| `--sort-order <value>` | No | Sort direction. Accepted values: `asc`, `desc`. |
| `--limit <n>` | No | Maximum items to return (0 for everything). Defaults to `100`. |
| `--limit <n>` | No | Maximum items to return (0 for everything). Defaults to `0`. |

</CommandTable>
2 changes: 1 addition & 1 deletion apps/docs/content/docs/cli/credentials.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ sim credentials list [options]
| `--search <value>` | No | Case-insensitive substring match against the credential display name. |
| `--sort-by <value>` | No | Field used to sort the result. Accepted values: `displayName`, `createdAt`, `updatedAt`. |
| `--sort-order <value>` | No | Sort direction. Accepted values: `asc`, `desc`. |
| `--limit <n>` | No | Maximum items to return (0 for everything). Defaults to `100`. |
| `--limit <n>` | No | Maximum items to return (0 for everything). Defaults to `0`. |

</CommandTable>

Expand Down
2 changes: 1 addition & 1 deletion apps/docs/content/docs/cli/custom-tools.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ sim custom-tools list [options]
| `--search <value>` | No | Case-insensitive substring match against the tool title. |
| `--sort-by <value>` | No | Field used to sort the result. Accepted values: `title`, `createdAt`, `updatedAt`. |
| `--sort-order <value>` | No | Sort direction. Accepted values: `asc`, `desc`. |
| `--limit <n>` | No | Maximum items to return (0 for everything). Defaults to `100`. |
| `--limit <n>` | No | Maximum items to return (0 for everything). Defaults to `0`. |

</CommandTable>

Expand Down
4 changes: 2 additions & 2 deletions apps/docs/content/docs/cli/files.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -292,7 +292,7 @@ sim files list [options]
| `--search <value>` | No | Case-insensitive substring match against the file name. |
| `--sort-by <value>` | No | Field used to sort the result. Sorting by `name` is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: `name`, `size`, `uploadedAt`, `updatedAt`. |
| `--sort-order <value>` | No | Sort direction. Accepted values: `asc`, `desc`. |
| `--limit <n>` | No | Maximum items to return (0 for everything). Defaults to `100`. |
| `--limit <n>` | No | Maximum items to return (0 for everything). Defaults to `0`. |

</CommandTable>

Expand Down Expand Up @@ -536,7 +536,7 @@ sim files ls [path] [options]
| Option | Required | Description |
| --- | --- | --- |
| `--search <text>` | No | Filter folders and resources by name. |
| `--limit <n>` | No | Maximum combined items to return (0 for everything). Defaults to `100`. |
| `--limit <n>` | No | Maximum combined items to return (0 for everything). Defaults to `0`. |

</CommandTable>

Expand Down
9 changes: 6 additions & 3 deletions apps/docs/content/docs/cli/knowledge.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -388,6 +388,7 @@ List Chunks (OAuth login or personal API key required)
| `--sort-by <value>` | No | Field used to sort the result. Accepted values: `chunkIndex`, `tokenCount`, `enabled`. |
| `--sort-order <value>` | No | Sort direction. Accepted values: `asc`, `desc`. |
| `--limit <n>` | No | Maximum items to return (0 for everything). Defaults to `100`. |
| `--cursor <value>` | No | Continue from nextCursor returned by a previous result. |

</CommandTable>

Expand Down Expand Up @@ -525,6 +526,7 @@ sim knowledge documents list <knowledgeBaseId> [options]
| `--enabled-filter <value>` | No | Filter by whether documents are enabled for search. Accepted values: `all`, `enabled`, `disabled`. |
| `--sort-by <value>` | No | Field used to sort the result. Sorting by `filename` is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: `filename`, `fileSize`, `tokenCount`, `chunkCount`, `uploadedAt`, `processingStatus`, `enabled`. |
| `--sort-order <value>` | No | Sort direction. Accepted values: `asc`, `desc`. |
| `--cursor <value>` | No | Continue from nextCursor returned by a previous result. |
| `--tag-filters <value>` | No | A JSON-encoded array of at most 10 tag filters, using the same display-name shape as knowledge search: `[&#123;"tagName":"category","operator":"eq","value":"billing"&#125;]`. Every filter must hold, including two that name the same tag. A name that is not defined in this knowledge base is rejected, never ignored. |

</CommandTable>
Expand Down Expand Up @@ -740,6 +742,7 @@ List Knowledge Connector Documents (OAuth login or personal API key required)
| `--include-excluded` | No | Include documents explicitly excluded by a user. |
| `--no-include-excluded` | No | Send --include-excluded as false. |
| `--limit <n>` | No | Maximum items to return (0 for everything). Defaults to `100`. |
| `--cursor <value>` | No | Continue from nextCursor returned by a previous result. |

</CommandTable>

Expand Down Expand Up @@ -799,7 +802,7 @@ List Knowledge Connectors (OAuth login or personal API key required)
| --- | --- | --- |
| `--sort-by <value>` | No | Field used to sort the result. Accepted values: `connectorType`, `createdAt`, `updatedAt`. |
| `--sort-order <value>` | No | Sort direction. Accepted values: `asc`, `desc`. |
| `--limit <n>` | No | Maximum items to return (0 for everything). Defaults to `100`. |
| `--limit <n>` | No | Maximum items to return (0 for everything). Defaults to `0`. |

</CommandTable>

Expand Down Expand Up @@ -1006,7 +1009,7 @@ sim knowledge list [options]
| `--search <value>` | No | Case-insensitive substring match against the resource name. |
| `--sort-by <value>` | No | Field used to sort the result. Sorting by `name` is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: `name`, `createdAt`, `updatedAt`. |
| `--sort-order <value>` | No | Sort direction. Accepted values: `asc`, `desc`. |
| `--limit <n>` | No | Maximum items to return (0 for everything). Defaults to `100`. |
| `--limit <n>` | No | Maximum items to return (0 for everything). Defaults to `0`. |

</CommandTable>

Expand Down Expand Up @@ -1119,7 +1122,7 @@ sim knowledge ls [path] [options]
| Option | Required | Description |
| --- | --- | --- |
| `--search <text>` | No | Filter folders and resources by name. |
| `--limit <n>` | No | Maximum combined items to return (0 for everything). Defaults to `100`. |
| `--limit <n>` | No | Maximum combined items to return (0 for everything). Defaults to `0`. |

</CommandTable>

Expand Down
1 change: 1 addition & 0 deletions apps/docs/content/docs/cli/logs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@ sim logs list [options]
| `--include-trace-spans` | No | Include trace spans in JSON or YAML output (implies full detail). |
| `--include-final-output` | No | Include final output in JSON or YAML output (implies full detail). |
| `--limit <n>` | No | Maximum items to return (0 for everything). Defaults to `100`. |
| `--cursor <value>` | No | Continue from nextCursor returned by a previous result. |
| `--status <value>` | No | Comma-separated execution statuses to include, from `pending` \| `running` \| `paused` \| `redacting` \| `completed` \| `failed` \| `cancelled`. An empty entry is rejected. ANDed with `level`, which reports severity rather than lifecycle. |
| `--workflow-name <value>` | No | Case-insensitive substring match against the run's workflow name. Runs whose workflow has been deleted match nothing, because the name is no longer joinable. |
| `--include-job-runs` | No | Include Chat and Sim-agent jobs alongside workflow runs. Jobs use `kind: "job"` and have no workflow or cost ledger. Workflow, folder, model, or status filters exclude jobs. This option is valid only when sorting by `startedAt`. |
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/content/docs/cli/mcp-servers.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ sim mcp-servers list [options]
| `--search <value>` | No | Case-insensitive substring match against the server name. |
| `--sort-by <value>` | No | Field used to sort the result. Sorting by `name` is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: `name`, `createdAt`, `updatedAt`. |
| `--sort-order <value>` | No | Sort direction. Accepted values: `asc`, `desc`. |
| `--limit <n>` | No | Maximum items to return (0 for everything). Defaults to `100`. |
| `--limit <n>` | No | Maximum items to return (0 for everything). Defaults to `0`. |

</CommandTable>

Expand Down
9 changes: 9 additions & 0 deletions apps/docs/content/docs/cli/output.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,15 @@ SIM_OUTPUT=yaml sim logs list > logs.yaml
`json` and `yaml` emit the API's raw values, not the table's formatting — a
duration stays `1500`, not `"1.5s"`.

Paginated lists include the rows under `data` and the continuation cursor under
`nextCursor`. A `null` cursor means no pages remain:

```json
{ "data": [{ "runId": "9c4f0b7e-2d81-4a35-b6e9-70f1c8a2d543" }], "nextCursor": null }
```

Read list rows with `jq '.data[]'` and check for more pages with `jq '.nextCursor'`.

`table` formats for reading: timestamps without milliseconds, sizes as `4.2 MB`,
booleans as `yes`/`no`, costs as `$0.0142`. Long cells are clipped to keep rows
on one line; switch to `json` for the full value.
Expand Down
Loading
Loading