@tsuga/cli 1.11.0 → 1.12.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +18 -0
  2. package/dist/cli.js +59 -58
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -181,6 +181,24 @@ You can also pass JSON inline with `-d`:
181
181
  tsuga teams create -d '{"name": "Platform", "visibility": "public"}'
182
182
  ```
183
183
 
184
+ ### Pagination
185
+
186
+ `list` returns the first 100 items by default. Paginated resources accept `--limit` (up to 1000) and `--offset`:
187
+
188
+ ```bash
189
+ tsuga monitors list --limit 500
190
+ tsuga monitors list --limit 500 --offset 500
191
+ ```
192
+
193
+ When a page leaves items behind, the CLI prints a notice to **stderr** and leaves stdout as
194
+ pure JSON, so `| jq` and `-o csv` are unaffected:
195
+
196
+ ```
197
+ Showing 100 of 4212 (offset 0). Use --limit (max 1000) and --offset 100 for the next page.
198
+ ```
199
+
200
+ For resources with server-side filters, narrowing the query beats paging through everything.
201
+
184
202
  ### Explaining a call with `--rationale`
185
203
 
186
204
  API-calling commands accept an optional `--rationale` flag to record why they are being run.