Commit be93441
docs(cli): object and array-of-object params do work via CLI (#646)
* docs(cli): object and array-of-object params do work via CLI
The Operations API commands page asserted in three places that nested
objects and arrays of objects cannot be passed as CLI arguments. That is
not true, and the page contradicted itself: it showed a working
`ids='["1","2","3"]'` array a few lines above the claim.
`buildRequest()` in `bin/cliOperations.ts` JSON-parses every argument
value, falling back to the raw string when the parse throws. Scalars,
arrays, and objects all take that one path, so there is no basis for
treating objects differently. `RAW_STRING_FIELDS` is `new Set(['ref'])` --
`ref` is the sole field exempted from the parse, so a numeric-looking git
tag is not rewritten into a number.
- State the actual parse rule once, at the top of Parameter Formatting,
and note the `ref` exception.
- Replace the "objects not supported" section with the `deploy_component`
`credentials` array-of-objects example that `harper deploy setup=true`
itself prints, plus the shell quoting rules that do apply.
- Rewrite Limitations around real constraints: raw binary bodies, the
OS argument-length cap, and secrets being visible in shell history,
`ps`, and CI logs. Drop the false nested-JSON and array-of-objects
entries, and the "file upload / streaming" entries that
`deploy_component` and `get_backup` disprove.
Closes #639
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
* docs(cli): point application-template at HarperFast
The `deploy_component` example linked to
`github.com/HarperDB/application-template`, which now only resolves via
the org-rename redirect. Verified `HarperFast/application-template` exists
and is not archived (`gh repo view`), so the canonical URL is used
directly.
The other two GitHub URLs on the page (`user/repo`,
`myorg/my-component`) are deliberate placeholders and are unchanged.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
---------
Co-authored-by: Claude Opus 5 <noreply@anthropic.com>1 parent 55228e7 commit be93441
1 file changed
Lines changed: 28 additions & 11 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
26 | 26 | | |
27 | 27 | | |
28 | 28 | | |
29 | | - | |
| 29 | + | |
30 | 30 | | |
31 | 31 | | |
32 | 32 | | |
| |||
204 | 204 | | |
205 | 205 | | |
206 | 206 | | |
207 | | - | |
| 207 | + | |
208 | 208 | | |
209 | 209 | | |
210 | 210 | | |
| |||
282 | 282 | | |
283 | 283 | | |
284 | 284 | | |
| 285 | + | |
| 286 | + | |
| 287 | + | |
| 288 | + | |
285 | 289 | | |
286 | 290 | | |
287 | 291 | | |
| |||
300 | 304 | | |
301 | 305 | | |
302 | 306 | | |
303 | | - | |
| 307 | + | |
| 308 | + | |
| 309 | + | |
| 310 | + | |
| 311 | + | |
| 312 | + | |
304 | 313 | | |
305 | | - | |
306 | | - | |
| 314 | + | |
| 315 | + | |
| 316 | + | |
| 317 | + | |
| 318 | + | |
| 319 | + | |
| 320 | + | |
| 321 | + | |
| 322 | + | |
| 323 | + | |
| 324 | + | |
307 | 325 | | |
308 | 326 | | |
309 | 327 | | |
| |||
369 | 387 | | |
370 | 388 | | |
371 | 389 | | |
372 | | - | |
| 390 | + | |
373 | 391 | | |
374 | | - | |
375 | | - | |
376 | | - | |
377 | | - | |
| 392 | + | |
| 393 | + | |
| 394 | + | |
378 | 395 | | |
379 | | - | |
| 396 | + | |
380 | 397 | | |
381 | 398 | | |
382 | 399 | | |
| |||
0 commit comments