@tigrisdata/cli 3.12.2 → 3.14.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 (129) hide show
  1. package/README.md +37 -4
  2. package/dist/auth/iam.js +1 -1
  3. package/dist/auth/provider.js +1 -1
  4. package/dist/browser/index.d.ts +18 -0
  5. package/dist/browser/index.js +463 -190
  6. package/dist/{chunk-WJWXPQBD.js → chunk-7BWCRJKU.js} +1 -1
  7. package/dist/{chunk-2NEE6EHO.js → chunk-A54TR6PZ.js} +1 -1
  8. package/dist/chunk-ABDWDZNK.js +4 -0
  9. package/dist/chunk-AG6GAJQM.js +5 -0
  10. package/dist/chunk-BTGWYSBL.js +2 -0
  11. package/dist/chunk-CIRQB45N.js +7 -0
  12. package/dist/{chunk-5HE5V2XI.js → chunk-CV77M3XG.js} +1 -1
  13. package/dist/{chunk-4Q7K4H7G.js → chunk-ELGUUOPX.js} +1 -1
  14. package/dist/{chunk-IUIKP2LU.js → chunk-EOCLTUJ4.js} +1 -1
  15. package/dist/chunk-GJLY3P2R.js +1 -0
  16. package/dist/chunk-K6JNY5VH.js +1 -0
  17. package/dist/{chunk-4IGHNCH2.js → chunk-P5DIPVOU.js} +1 -1
  18. package/dist/{chunk-RKQ4APOU.js → chunk-PAANXFCH.js} +1 -1
  19. package/dist/{chunk-ARZNOO2O.js → chunk-PGHGQCUB.js} +1 -1
  20. package/dist/{chunk-OLHVLEN3.js → chunk-QBBCW6FL.js} +1 -1
  21. package/dist/chunk-RAA7DIID.js +3 -0
  22. package/dist/{chunk-M63SODRY.js → chunk-X554SYWE.js} +1 -1
  23. package/dist/chunk-Y36SHW6I.js +14 -0
  24. package/dist/{chunk-RDGK5VBP.js → chunk-YJ2RZYU4.js} +1 -1
  25. package/dist/cli-core.js +1 -1
  26. package/dist/cli.js +1 -1
  27. package/dist/help.js +1 -0
  28. package/dist/index.js +1 -1
  29. package/dist/lib/access-keys/assign.js +1 -1
  30. package/dist/lib/access-keys/attach-policy.js +1 -1
  31. package/dist/lib/access-keys/create.js +2 -1
  32. package/dist/lib/access-keys/delete.js +1 -1
  33. package/dist/lib/access-keys/detach-policy.js +1 -1
  34. package/dist/lib/access-keys/get.js +1 -1
  35. package/dist/lib/access-keys/list-policies.js +1 -1
  36. package/dist/lib/access-keys/list.js +1 -1
  37. package/dist/lib/access-keys/roles.js +1 -0
  38. package/dist/lib/access-keys/rotate.js +1 -1
  39. package/dist/lib/buckets/create.js +1 -1
  40. package/dist/lib/buckets/delete.js +1 -1
  41. package/dist/lib/buckets/disable-snapshots.js +1 -1
  42. package/dist/lib/buckets/enable-snapshots.js +1 -1
  43. package/dist/lib/buckets/get.js +1 -1
  44. package/dist/lib/buckets/lifecycle/create.js +1 -1
  45. package/dist/lib/buckets/lifecycle/edit.js +1 -1
  46. package/dist/lib/buckets/lifecycle/list.js +1 -1
  47. package/dist/lib/buckets/lifecycle/shared.js +1 -1
  48. package/dist/lib/buckets/list.js +1 -1
  49. package/dist/lib/buckets/merge.js +1 -1
  50. package/dist/lib/buckets/migrate.js +1 -1
  51. package/dist/lib/buckets/rebase.js +1 -1
  52. package/dist/lib/buckets/restore.js +1 -1
  53. package/dist/lib/buckets/set-cors.js +1 -1
  54. package/dist/lib/buckets/set-locations.js +1 -1
  55. package/dist/lib/buckets/set-migration.js +1 -1
  56. package/dist/lib/buckets/set-notifications.js +1 -1
  57. package/dist/lib/buckets/set.js +1 -1
  58. package/dist/lib/buckets/share.js +1 -1
  59. package/dist/lib/bundle.js +1 -1
  60. package/dist/lib/configure/index.js +1 -1
  61. package/dist/lib/cp.js +1 -1
  62. package/dist/lib/credentials/test.js +1 -1
  63. package/dist/lib/iam/policies/create.js +1 -1
  64. package/dist/lib/iam/policies/delete.js +1 -1
  65. package/dist/lib/iam/policies/edit.js +1 -1
  66. package/dist/lib/iam/policies/get.js +1 -1
  67. package/dist/lib/iam/policies/link-key.js +1 -1
  68. package/dist/lib/iam/policies/list-keys.js +1 -1
  69. package/dist/lib/iam/policies/list.js +1 -1
  70. package/dist/lib/iam/policies/select-policy.js +1 -1
  71. package/dist/lib/iam/policies/unlink-key.js +1 -1
  72. package/dist/lib/iam/teams/create.js +1 -1
  73. package/dist/lib/iam/teams/edit.js +1 -1
  74. package/dist/lib/iam/teams/list.js +1 -1
  75. package/dist/lib/iam/teams/shared.js +1 -1
  76. package/dist/lib/iam/users/invite.js +1 -1
  77. package/dist/lib/iam/users/list.js +1 -1
  78. package/dist/lib/iam/users/remove.js +1 -1
  79. package/dist/lib/iam/users/revoke-invitation.js +1 -1
  80. package/dist/lib/iam/users/update-role.js +1 -1
  81. package/dist/lib/init/index.js +1 -1
  82. package/dist/lib/init/plan.js +1 -1
  83. package/dist/lib/login/credentials.js +1 -1
  84. package/dist/lib/login/oauth.js +1 -1
  85. package/dist/lib/login/select.js +1 -1
  86. package/dist/lib/logout.js +1 -1
  87. package/dist/lib/ls.js +1 -1
  88. package/dist/lib/mk.js +1 -1
  89. package/dist/lib/mv.js +1 -1
  90. package/dist/lib/objects/delete.js +1 -1
  91. package/dist/lib/objects/get.js +1 -1
  92. package/dist/lib/objects/info.js +1 -1
  93. package/dist/lib/objects/list-versions.js +1 -1
  94. package/dist/lib/objects/list.js +1 -1
  95. package/dist/lib/objects/purge.js +1 -1
  96. package/dist/lib/objects/put.js +1 -1
  97. package/dist/lib/objects/restore-deleted.js +1 -1
  98. package/dist/lib/objects/restore-info.js +1 -1
  99. package/dist/lib/objects/restore.js +1 -1
  100. package/dist/lib/objects/set-access.js +1 -1
  101. package/dist/lib/objects/set.js +1 -1
  102. package/dist/lib/organizations/create.js +1 -1
  103. package/dist/lib/organizations/list.js +1 -1
  104. package/dist/lib/organizations/select.js +1 -1
  105. package/dist/lib/presign.js +1 -1
  106. package/dist/lib/rm.js +1 -1
  107. package/dist/lib/snapshots/delete.js +1 -1
  108. package/dist/lib/snapshots/list.js +1 -1
  109. package/dist/lib/snapshots/take.js +1 -1
  110. package/dist/lib/stat.js +1 -1
  111. package/dist/lib/telemetry/disable.js +1 -1
  112. package/dist/lib/telemetry/enable.js +1 -1
  113. package/dist/lib/telemetry/status.js +1 -1
  114. package/dist/lib/touch.js +1 -1
  115. package/dist/lib/update.js +1 -1
  116. package/dist/lib/whoami.js +1 -1
  117. package/dist/specs.yaml +280 -19
  118. package/dist/utils/analytics.js +1 -1
  119. package/dist/utils/bucket-info.js +1 -1
  120. package/dist/utils/credentials-export.js +1 -0
  121. package/dist/utils/exit.js +1 -1
  122. package/dist/utils/telemetry.js +1 -1
  123. package/dist/utils/update-check.js +1 -1
  124. package/package.json +3 -3
  125. package/dist/chunk-DCSVQMPM.js +0 -2
  126. package/dist/chunk-F67MYOOP.js +0 -1
  127. package/dist/chunk-JELDAKLB.js +0 -30
  128. package/dist/chunk-JRLZXECQ.js +0 -5
  129. package/dist/chunk-NNZ3E7E5.js +0 -10
package/dist/specs.yaml CHANGED
@@ -76,18 +76,57 @@ definitions:
76
76
 
77
77
  access_options: &access_options [public, private]
78
78
 
79
+ # Declared by every command that asks for confirmation, which is what lists
80
+ # --yes in that command's help.
81
+ yes_argument: &yes_argument
82
+ name: yes
83
+ description: Skip confirmation prompts
84
+ type: flag
85
+ alias: "y"
86
+
87
+ # Bucket roles for an access key, shared by `access-keys assign` and the
88
+ # create-time scoping on `access-keys create`.
89
+ key_bucket_argument: &key_bucket_argument
90
+ name: bucket
91
+ alias: b
92
+ description: Bucket name (can specify multiple, comma-separated). Each bucket is paired positionally with a --role value
93
+ helpText: Bucket name(s), comma-separated. Each pairs positionally with a --role
94
+ multiple: true
95
+ key_role_argument: &key_role_argument
96
+ name: role
97
+ alias: r
98
+ description: Role to assign (can specify multiple, comma-separated). Each role pairs with the corresponding --bucket value
99
+ helpText: Role(s) to assign, comma-separated. Each pairs with a --bucket
100
+ multiple: true
101
+ options:
102
+ - Editor
103
+ - ReadWrite
104
+ - ReadOnly
105
+ key_admin_argument: &key_admin_argument
106
+ name: admin
107
+ description: Grant admin access to all buckets in the organization
108
+ type: flag
109
+
79
110
  global_arguments: &global_arguments
80
111
  - name: format
81
112
  description: Output format
82
113
  options: [json, table]
83
114
  default: table
84
115
  - name: json
85
- description: Output as JSON
116
+ description: Shorthand for --format json
86
117
  type: flag
118
+ # Accepted by every command so scripts can pass -y blindly, but hidden from
119
+ # help unless the command declares *yes_argument itself. This entry is only
120
+ # shown on the root page, hence the qualifier.
87
121
  - name: yes
88
- description: Skip confirmation prompts
122
+ description: Skip confirmation prompts on commands that ask
89
123
  type: flag
90
124
  alias: "y"
125
+ hidden: true
126
+
127
+ # Headings for the root command list, in display order. The built-in help and
128
+ # version commands join the last one.
129
+ groups: [Get started, Unix-style commands, Manage resources, CLI]
91
130
 
92
131
  commands:
93
132
  #########################
@@ -95,8 +134,10 @@ commands:
95
134
  #########################
96
135
  # init
97
136
  - name: init
137
+ group: Get started
98
138
  alias: start
99
139
  description: Connect Tigris to your AI coding agent — MCP server config and agent skills
140
+ helpText: Connect Tigris to your AI coding agent
100
141
  examples:
101
142
  - "tigris init"
102
143
  - "npx tigris init"
@@ -108,6 +149,7 @@ commands:
108
149
  arguments:
109
150
  - name: agent
110
151
  description: Print a setup recipe for an AI coding agent to follow instead of running the interactive wizard
152
+ helpText: Print a setup recipe for an AI agent instead of running the wizard
111
153
  type: flag
112
154
 
113
155
  #########################
@@ -115,7 +157,9 @@ commands:
115
157
  #########################
116
158
  # configure
117
159
  - name: configure
160
+ group: Get started
118
161
  description: Save access-key credentials to ~/.tigris/config.json for persistent use across all commands
162
+ helpText: Save access-key credentials for all commands
119
163
  alias: c
120
164
  examples:
121
165
  - "tigris configure --access-key tid_AaBb --access-secret tsec_XxYy"
@@ -145,7 +189,9 @@ commands:
145
189
 
146
190
  # login
147
191
  - name: login
192
+ group: Get started
148
193
  description: Start a session via OAuth (default) or temporary credentials. Session state is cleared on logout
194
+ helpText: Start a session via OAuth or temporary credentials
149
195
  examples:
150
196
  - "tigris login"
151
197
  - "tigris login oauth"
@@ -168,6 +214,7 @@ commands:
168
214
  # login (main interactive operation)
169
215
  - name: select
170
216
  description: Choose how to login - OAuth (browser) or credentials (access key)
217
+ helpText: "Choose how to log in: OAuth or access key"
171
218
  messages:
172
219
  onStart: ''
173
220
  onSuccess: 'Login successful'
@@ -175,6 +222,7 @@ commands:
175
222
  # oauth
176
223
  - name: oauth
177
224
  description: Login via browser using OAuth2 device flow. Best for interactive use
225
+ helpText: Log in through the browser with OAuth
178
226
  alias: o
179
227
  examples:
180
228
  - "tigris login oauth"
@@ -192,6 +240,7 @@ commands:
192
240
  # credentials
193
241
  - name: credentials
194
242
  description: Login with an access key and secret. Creates a temporary session that is cleared on logout
243
+ helpText: Log in with an access key and secret
195
244
  alias: c
196
245
  examples:
197
246
  - "tigris login credentials --access-key tid_AaBb --access-secret tsec_XxYy"
@@ -216,7 +265,9 @@ commands:
216
265
 
217
266
  # whoami
218
267
  - name: whoami
268
+ group: Get started
219
269
  description: Print the currently authenticated user, organization, and auth method
270
+ helpText: Show the current user, organization, and auth method
220
271
  alias: w
221
272
  examples:
222
273
  - "tigris whoami"
@@ -227,6 +278,7 @@ commands:
227
278
  onAlreadyDone: "Not authenticated\nRun \"tigris login\" to authenticate"
228
279
  # update
229
280
  - name: update
281
+ group: CLI
230
282
  description: Update the CLI to the latest version
231
283
  examples:
232
284
  - "tigris update"
@@ -238,7 +290,9 @@ commands:
238
290
 
239
291
  # logout
240
292
  - name: logout
293
+ group: Get started
241
294
  description: End the current session and clear login state. Credentials saved via 'configure' are kept
295
+ helpText: End the current session and clear login state
242
296
  examples:
243
297
  - "tigris logout"
244
298
  messages:
@@ -248,7 +302,9 @@ commands:
248
302
 
249
303
  # credentials
250
304
  - name: credentials
305
+ group: Get started
251
306
  description: Test whether your current credentials can reach Tigris and optionally verify access to a specific bucket
307
+ helpText: Test whether your credentials can reach Tigris
252
308
  alias: creds
253
309
  examples:
254
310
  - "tigris credentials test"
@@ -256,6 +312,7 @@ commands:
256
312
  commands:
257
313
  - name: test
258
314
  description: Verify that current credentials are valid. Optionally checks access to a specific bucket
315
+ helpText: Verify credentials, optionally against a bucket
259
316
  alias: t
260
317
  examples:
261
318
  - "tigris credentials test"
@@ -276,7 +333,9 @@ commands:
276
333
  #########################
277
334
  # telemetry
278
335
  - name: telemetry
336
+ group: CLI
279
337
  description: Show or change whether the CLI sends usage analytics and error reports
338
+ helpText: Show or change usage analytics and error reporting
280
339
  default: status
281
340
  examples:
282
341
  - "tigris telemetry"
@@ -286,6 +345,7 @@ commands:
286
345
  commands:
287
346
  - name: status
288
347
  description: Show whether telemetry is enabled, what is collected, and which setting is in effect
348
+ helpText: Show whether telemetry is on and what is collected
289
349
  examples:
290
350
  - "tigris telemetry status"
291
351
  messages:
@@ -302,6 +362,7 @@ commands:
302
362
  onFailure: 'Failed to disable telemetry'
303
363
  - name: enable
304
364
  description: Turn usage analytics and error reports back on for this machine
365
+ helpText: Turn usage analytics and error reports back on
305
366
  examples:
306
367
  - "tigris telemetry enable"
307
368
  messages:
@@ -314,7 +375,9 @@ commands:
314
375
  #########################
315
376
  # ls
316
377
  - name: ls
378
+ group: Unix-style commands
317
379
  description: List all buckets (no arguments) or objects under a bucket/prefix path. Accepts bare names or t3:// URIs
380
+ helpText: List buckets, or objects under a bucket/prefix path
318
381
  alias: list
319
382
  examples:
320
383
  - "tigris ls"
@@ -328,6 +391,7 @@ commands:
328
391
  - name: path
329
392
  type: positional
330
393
  description: A bucket name or bucket/prefix path. Omit to list all buckets. Supports t3:// and tigris:// prefixes
394
+ helpText: Bucket name or bucket/prefix path. Omit to list all buckets
331
395
  examples:
332
396
  - my-bucket
333
397
  - my-bucket/my-path
@@ -335,6 +399,7 @@ commands:
335
399
  - t3://my-bucket/my-path
336
400
  - name: snapshot-version
337
401
  description: Read from a specific bucket snapshot. Accepts a snapshot version string or any UNIX nanosecond-precision timestamp (e.g. 1765889000501544464)
402
+ helpText: Read from a bucket snapshot (version or UNIX nanosecond timestamp)
338
403
  alias: snapshot
339
404
  - name: format
340
405
  description: Output format
@@ -347,11 +412,14 @@ commands:
347
412
  alias: pt
348
413
  - name: source
349
414
  description: List objects from a specific storage source on buckets with shadow migration enabled
415
+ helpText: Storage source to list from on shadow-migration buckets
350
416
  options: [tigris, shadow]
351
417
 
352
418
  # mk
353
419
  - name: mk
420
+ group: Unix-style commands
354
421
  description: Create a bucket (bare name) or a folder inside a bucket (bucket/folder/ with trailing slash)
422
+ helpText: Create a bucket, or a folder inside a bucket
355
423
  alias: create
356
424
  examples:
357
425
  - "tigris mk my-bucket"
@@ -369,6 +437,7 @@ commands:
369
437
  required: true
370
438
  type: positional
371
439
  description: A bucket name or bucket/folder/ path. Trailing slash creates a folder inside the bucket. Supports t3:// and tigris:// prefixes
440
+ helpText: Bucket name, or bucket/folder/ path (trailing slash creates a folder)
372
441
  examples:
373
442
  - my-bucket
374
443
  - my-bucket/my-path
@@ -393,6 +462,7 @@ commands:
393
462
  default: false
394
463
  - name: enable-directory-listing
395
464
  description: Enable directory listing, relevant for public buckets (only applies when creating a bucket)
465
+ helpText: Enable directory listing for a public bucket (bucket creation only)
396
466
  type: flag
397
467
  default: false
398
468
  - name: default-tier
@@ -418,11 +488,14 @@ commands:
418
488
  alias: fork
419
489
  - name: source-snapshot
420
490
  description: Fork from a specific snapshot of the source bucket. Accepts a snapshot version string or any UNIX nanosecond-precision timestamp (e.g. 1765889000501544464). Requires --fork-of
491
+ helpText: Fork from this snapshot (version or UNIX ns timestamp). Requires --fork-of
421
492
  alias: source-snap
422
493
 
423
494
  # touch
424
495
  - name: touch
496
+ group: Unix-style commands
425
497
  description: Create an empty (zero-byte) object at the given bucket/key path
498
+ helpText: Create an empty object at a bucket/key path
426
499
  examples:
427
500
  - "tigris touch my-bucket/placeholder.txt"
428
501
  - "tigris touch t3://my-bucket/logs/"
@@ -439,7 +512,9 @@ commands:
439
512
 
440
513
  # stat
441
514
  - name: stat
515
+ group: Unix-style commands
442
516
  description: Show storage stats (no args), bucket info, or object metadata
517
+ helpText: Show storage stats, bucket info, or object metadata
443
518
  examples:
444
519
  - "tigris stat"
445
520
  - "tigris stat t3://my-bucket"
@@ -463,13 +538,17 @@ commands:
463
538
  default: table
464
539
  - name: snapshot-version
465
540
  description: Read from a specific bucket snapshot. Accepts a snapshot version string or any UNIX nanosecond-precision timestamp (e.g. 1765889000501544464)
541
+ helpText: Read from a bucket snapshot (version or UNIX nanosecond timestamp)
466
542
  alias: snapshot
467
543
  - name: version-id
468
544
  description: Object version id to stat (requires bucket versioning). Omit to stat the latest version
545
+ helpText: Object version id to stat. Omit for the latest version
469
546
 
470
547
  # presign
471
548
  - name: presign
549
+ group: Unix-style commands
472
550
  description: Generate a presigned URL for temporary access to an object without credentials
551
+ helpText: Generate a presigned URL for temporary object access
473
552
  examples:
474
553
  - "tigris presign my-bucket/file.txt"
475
554
  - "tigris presign t3://my-bucket/report.pdf --method put --expires-in 7200"
@@ -498,6 +577,7 @@ commands:
498
577
  default: '3600'
499
578
  - name: access-key
500
579
  description: Access key ID to use for signing. If not provided, resolved from credentials or auto-selected
580
+ helpText: Access key ID to sign with. Defaults to your current credentials
501
581
  - name: select
502
582
  description: Interactively select an access key (OAuth only)
503
583
  type: flag
@@ -507,11 +587,14 @@ commands:
507
587
  default: url
508
588
  - name: snapshot-version
509
589
  description: Read from a specific bucket snapshot. Accepts a snapshot version string or any UNIX nanosecond-precision timestamp (e.g. 1765889000501544464). Only supported for GET requests.
590
+ helpText: Read from a bucket snapshot (version or UNIX nanosecond timestamp). GET only
510
591
  alias: snapshot
511
592
 
512
593
  # cp
513
594
  - name: cp
595
+ group: Unix-style commands
514
596
  description: Copy files between local filesystem and Tigris, or between paths within Tigris. At least one side must be a remote t3:// path
597
+ helpText: Copy files to, from, or within Tigris
515
598
  alias: copy
516
599
  examples:
517
600
  - "tigris cp ./file.txt t3://my-bucket/file.txt"
@@ -527,6 +610,7 @@ commands:
527
610
  required: true
528
611
  type: positional
529
612
  description: Source path. Use t3:// (or tigris://) prefix for remote Tigris paths, bare paths for local files. At least one side must be remote. Quote wildcard patterns to prevent shell expansion
613
+ helpText: Source path. Prefix remote paths with t3://; quote wildcards
530
614
  examples:
531
615
  - ./file.txt
532
616
  - ./dir/
@@ -537,6 +621,7 @@ commands:
537
621
  required: true
538
622
  type: positional
539
623
  description: Destination path. Use t3:// (or tigris://) prefix for remote Tigris paths, bare paths for local files
624
+ helpText: Destination path. Prefix remote paths with t3://
540
625
  examples:
541
626
  - .
542
627
  - ./local-dir/
@@ -552,10 +637,13 @@ commands:
552
637
  options: *access_options
553
638
  - name: cache-control
554
639
  description: Cache-Control header stored with uploaded objects (only applies to local-to-remote uploads)
640
+ helpText: Cache-Control header for uploaded objects (local-to-remote only)
555
641
 
556
642
  # mv
557
643
  - name: mv
644
+ group: Unix-style commands
558
645
  description: Move (rename) objects within Tigris. Both source and destination must be remote t3:// paths
646
+ helpText: Move or rename objects within Tigris
559
647
  alias: move
560
648
  examples:
561
649
  - "tigris mv t3://my-bucket/old.txt t3://my-bucket/new.txt -f"
@@ -564,10 +652,12 @@ commands:
564
652
  messages:
565
653
  onFailure: 'Move failed. Verify both paths are remote and credentials have access'
566
654
  arguments:
655
+ - *yes_argument
567
656
  - name: src
568
657
  type: positional
569
658
  required: true
570
659
  description: Remote source path. Use t3:// (or tigris://) prefix. Quote wildcard patterns to prevent shell expansion
660
+ helpText: Remote source path (t3:// prefix). Quote wildcards
571
661
  examples:
572
662
  - t3://my-bucket/my-path/my-object.json
573
663
  - t3://my-bucket/my-path/
@@ -590,7 +680,9 @@ commands:
590
680
 
591
681
  # rm
592
682
  - name: rm
683
+ group: Unix-style commands
593
684
  description: Remove a bucket, folder, or object from Tigris. A bare bucket name deletes the bucket itself
685
+ helpText: Remove a bucket, folder, or object
594
686
  alias: remove
595
687
  examples:
596
688
  - "tigris rm t3://my-bucket/file.txt -f"
@@ -600,10 +692,12 @@ commands:
600
692
  messages:
601
693
  onFailure: 'Remove failed. Verify the path exists and credentials have delete access'
602
694
  arguments:
695
+ - *yes_argument
603
696
  - name: path
604
697
  type: positional
605
698
  required: true
606
699
  description: Remote path to remove. A bucket-only path removes the bucket. Use t3:// (or tigris://) prefix. Quote wildcard patterns to prevent shell expansion
700
+ helpText: Remote path to remove; a bucket-only path removes the bucket. Quote wildcards
607
701
  examples:
608
702
  - t3://my-bucket
609
703
  - t3://my-bucket/my-path/my-object.json
@@ -620,7 +714,9 @@ commands:
620
714
 
621
715
  # bundle
622
716
  - name: bundle
717
+ group: Unix-style commands
623
718
  description: Download multiple objects as a streaming tar archive in a single request. Designed for batch workloads that need many objects without per-object HTTP overhead
719
+ helpText: Download multiple objects as a streaming tar archive
624
720
  examples:
625
721
  - "tigris bundle my-bucket --keys key1.jpg,key2.jpg --output archive.tar"
626
722
  - "tigris bundle my-bucket --keys keys.txt --output archive.tar"
@@ -640,12 +736,14 @@ commands:
640
736
  - t3://my-bucket
641
737
  - name: keys
642
738
  description: "Comma-separated object keys, or path to a file with one key per line. If a local file matching the value exists, it is read as a keys file. If omitted, reads keys from stdin"
739
+ helpText: Comma-separated keys, or a file with one key per line. Omit to read stdin
643
740
  alias: k
644
741
  - name: output
645
742
  description: Output file path. Defaults to stdout (for piping)
646
743
  alias: o
647
744
  - name: compression
648
745
  description: Compression algorithm for the archive. Auto-detected from output file extension when not specified
746
+ helpText: Archive compression. Auto-detected from the output file extension
649
747
  options: [none, gzip, zstd]
650
748
  - name: on-error
651
749
  description: How to handle missing objects. 'skip' omits them, 'fail' aborts the request
@@ -656,8 +754,10 @@ commands:
656
754
  # Manage organizations
657
755
  #########################
658
756
  - name: organizations
757
+ group: Manage resources
659
758
  alias: orgs
660
759
  description: List, create, and switch between organizations. An organization is a workspace that contains your resources like buckets and access keys
760
+ helpText: List, create, and switch between organizations
661
761
  examples:
662
762
  - "tigris orgs list"
663
763
  - "tigris orgs create my-org"
@@ -666,6 +766,7 @@ commands:
666
766
  # list
667
767
  - name: list
668
768
  description: List all organizations you belong to and interactively select one as active
769
+ helpText: List your organizations and select the active one
669
770
  alias: l
670
771
  examples:
671
772
  - "tigris orgs list"
@@ -706,6 +807,7 @@ commands:
706
807
  - my-organization
707
808
  - name: select
708
809
  description: Set the named organization as your active org for all subsequent commands
810
+ helpText: Set your active organization
709
811
  alias: s
710
812
  examples:
711
813
  - "tigris orgs select my-org"
@@ -730,7 +832,10 @@ commands:
730
832
  # Manage buckets
731
833
  #########################
732
834
  - name: buckets
835
+ group: Manage resources
836
+ groups: [Basics, Forks & snapshots, Configuration, Migration]
733
837
  description: Create, inspect, update, and delete buckets. Buckets are top-level containers that hold objects
838
+ helpText: Create, inspect, update, and delete buckets
734
839
  alias: b
735
840
  examples:
736
841
  - "tigris buckets list"
@@ -740,12 +845,15 @@ commands:
740
845
  commands:
741
846
  # list
742
847
  - name: list
848
+ group: Basics
743
849
  description: List all buckets in the current organization
744
850
  alias: l
745
851
  examples:
746
852
  - "tigris buckets list"
747
853
  - "tigris buckets list --format json"
748
854
  - "tigris buckets list --forks-of my-bucket"
855
+ - "tigris buckets list --forks-only"
856
+ - "tigris buckets list --owner alice@example.com"
749
857
  - "tigris buckets list --deleted"
750
858
  messages:
751
859
  onStart: 'Listing buckets...'
@@ -762,6 +870,12 @@ commands:
762
870
  - name: deleted
763
871
  description: Only list soft-deleted buckets
764
872
  type: flag
873
+ - name: forks-only
874
+ description: Only list buckets that are forks of another bucket
875
+ type: flag
876
+ - name: owner
877
+ description: Only list buckets owned by this user, by username (an email address)
878
+ helpText: Only buckets owned by this user (email)
765
879
  - name: limit
766
880
  description: Maximum number of items to return per page
767
881
  - name: page-token
@@ -769,7 +883,9 @@ commands:
769
883
  alias: pt
770
884
  # create
771
885
  - name: create
886
+ group: Basics
772
887
  description: Create a new bucket with optional access, tier, and location settings
888
+ helpText: Create a new bucket
773
889
  alias: c
774
890
  examples:
775
891
  - "tigris buckets create my-bucket"
@@ -839,10 +955,13 @@ commands:
839
955
  alias: fork
840
956
  - name: source-snapshot
841
957
  description: Fork from a specific snapshot of the source bucket. Accepts a snapshot version string or any UNIX nanosecond-precision timestamp (e.g. 1765889000501544464). Requires --fork-of
958
+ helpText: Fork from this snapshot (version or UNIX ns timestamp). Requires --fork-of
842
959
  alias: source-snap
843
960
  # rebase
844
961
  - name: rebase
962
+ group: Forks & snapshots
845
963
  description: Update a fork with the latest changes from its source bucket
964
+ helpText: Update a fork with its source bucket's latest changes
846
965
  examples:
847
966
  - "tigris buckets rebase my-fork"
848
967
  - "tigris buckets rebase my-fork --yes"
@@ -854,6 +973,7 @@ commands:
854
973
  - command: 'tigris buckets merge {{fork}}'
855
974
  description: "Merge the fork's changes back into its source bucket"
856
975
  arguments:
976
+ - *yes_argument
857
977
  - name: fork
858
978
  description: Name of the fork bucket to rebase onto its source
859
979
  type: positional
@@ -862,6 +982,7 @@ commands:
862
982
  - my-fork
863
983
  # merge
864
984
  - name: merge
985
+ group: Forks & snapshots
865
986
  description: Merge a fork's changes back into its source bucket
866
987
  examples:
867
988
  - "tigris buckets merge my-fork"
@@ -876,6 +997,7 @@ commands:
876
997
  - command: 'tigris buckets get {{into}}'
877
998
  description: 'Inspect the updated source bucket'
878
999
  arguments:
1000
+ - *yes_argument
879
1001
  - name: fork
880
1002
  description: Name of the fork bucket whose changes will be merged
881
1003
  type: positional
@@ -887,10 +1009,13 @@ commands:
887
1009
  alias: source
888
1010
  - name: from-snapshot
889
1011
  description: Merge from a specific snapshot of the fork rather than its current state. Accepts a snapshot version string or any UNIX nanosecond-precision timestamp (e.g. 1765889000501544464)
1012
+ helpText: Merge from a snapshot of the fork (version or UNIX nanosecond timestamp)
890
1013
  alias: from-snap
891
1014
  # get
892
1015
  - name: get
1016
+ group: Basics
893
1017
  description: Show details for a bucket including access level, region, tier, and custom domain
1018
+ helpText: Show a bucket's access level, region, tier, and domain
894
1019
  alias: g
895
1020
  examples:
896
1021
  - "tigris buckets get my-bucket"
@@ -911,7 +1036,9 @@ commands:
911
1036
  default: table
912
1037
  # delete
913
1038
  - name: delete
1039
+ group: Basics
914
1040
  description: Delete one or more buckets by name. The bucket must be empty or delete-protection must be off
1041
+ helpText: Delete one or more buckets
915
1042
  alias: d
916
1043
  examples:
917
1044
  - "tigris buckets delete my-bucket --yes"
@@ -924,6 +1051,7 @@ commands:
924
1051
  - command: 'tigris ls'
925
1052
  description: 'List remaining buckets'
926
1053
  arguments:
1054
+ - *yes_argument
927
1055
  - name: name
928
1056
  description: Name of the bucket or comma separated list of buckets
929
1057
  type: positional
@@ -936,7 +1064,9 @@ commands:
936
1064
  description: Skip confirmation prompts (alias for --yes)
937
1065
  # restore
938
1066
  - name: restore
1067
+ group: Basics
939
1068
  description: Restore a soft-deleted bucket within its retention window. List recoverable buckets with "tigris buckets list --deleted"
1069
+ helpText: Restore a soft-deleted bucket
940
1070
  examples:
941
1071
  - "tigris buckets restore my-bucket"
942
1072
  messages:
@@ -955,7 +1085,9 @@ commands:
955
1085
  - my-bucket
956
1086
  # set
957
1087
  - name: set
1088
+ group: Basics
958
1089
  description: Update settings on an existing bucket such as access level, default tier, location, caching, or custom domain
1090
+ helpText: Update settings on an existing bucket
959
1091
  alias: s
960
1092
  examples:
961
1093
  - "tigris buckets set my-bucket --access public"
@@ -986,6 +1118,7 @@ commands:
986
1118
  replaced_by: --locations
987
1119
  - name: locations
988
1120
  description: Bucket location (see https://www.tigrisdata.com/docs/buckets/locations/ for more details)
1121
+ helpText: Bucket location(s), comma-separated
989
1122
  options: *location_options
990
1123
  multiple: true
991
1124
  - name: allow-object-acl
@@ -1005,15 +1138,19 @@ commands:
1005
1138
  replaced_by: --soft-delete
1006
1139
  - name: soft-delete
1007
1140
  description: Enable or disable soft delete (recoverable deletes). Requires --retention-days when enabling
1141
+ helpText: Enable or disable soft delete. Enabling requires --retention-days
1008
1142
  options: [enable, disable]
1009
1143
  - name: retention-days
1010
1144
  description: Number of days to retain soft-deleted objects (required when enabling --soft-delete)
1145
+ helpText: Days to retain soft-deleted objects (required when enabling soft delete)
1011
1146
  - name: enable-additional-headers
1012
1147
  description: Enable additional HTTP headers (X-Content-Type-Options nosniff)
1013
1148
  type: boolean
1014
1149
  # enable-snapshots
1015
1150
  - name: enable-snapshots
1151
+ group: Forks & snapshots
1016
1152
  description: Enable snapshots on an existing bucket, converting it to a snapshot bucket
1153
+ helpText: Enable snapshots on an existing bucket
1017
1154
  examples:
1018
1155
  - "tigris buckets enable-snapshots my-bucket"
1019
1156
  messages:
@@ -1029,7 +1166,9 @@ commands:
1029
1166
  - my-bucket
1030
1167
  # disable-snapshots
1031
1168
  - name: disable-snapshots
1169
+ group: Forks & snapshots
1032
1170
  description: Disable snapshots on an existing bucket, converting it back to a regular bucket. Rejected while the bucket has dependent forks
1171
+ helpText: Disable snapshots on an existing bucket
1033
1172
  examples:
1034
1173
  - "tigris buckets disable-snapshots my-bucket"
1035
1174
  messages:
@@ -1049,6 +1188,7 @@ commands:
1049
1188
  replaced_by: 'tigris buckets lifecycle create <bucket> --expire-days <N>'
1050
1189
  # set-locations
1051
1190
  - name: set-locations
1191
+ group: Configuration
1052
1192
  description: Set the data locations for a bucket
1053
1193
  examples:
1054
1194
  - "tigris buckets set-locations my-bucket --locations iad"
@@ -1072,7 +1212,9 @@ commands:
1072
1212
  multiple: true
1073
1213
  # set-migration
1074
1214
  - name: set-migration
1215
+ group: Migration
1075
1216
  description: Configure data migration from an external S3-compatible source bucket. Tigris will pull objects on demand from the source
1217
+ helpText: Configure on-demand migration from an S3-compatible bucket
1076
1218
  examples:
1077
1219
  - "tigris buckets set-migration my-bucket --bucket source-bucket --endpoint https://s3.amazonaws.com --region us-east-1 --access-key AKIA... --secret-key wJal..."
1078
1220
  - "tigris buckets set-migration my-bucket --bucket source-bucket --endpoint https://s3.amazonaws.com --region us-east-1 --access-key AKIA... --secret-key wJal... --write-through"
@@ -1111,7 +1253,9 @@ commands:
1111
1253
  type: flag
1112
1254
  # migrate
1113
1255
  - name: migrate
1256
+ group: Migration
1114
1257
  description: Actively migrate all objects from a shadow bucket to Tigris by scheduling server-side migration for unmigrated objects
1258
+ helpText: Actively migrate all objects from a shadow bucket
1115
1259
  examples:
1116
1260
  - "tigris buckets migrate my-bucket"
1117
1261
  - "tigris buckets migrate my-bucket/images/"
@@ -1132,6 +1276,7 @@ commands:
1132
1276
  - t3://my-bucket/prefix/
1133
1277
  - name: max-in-flight-gb
1134
1278
  description: Max total gigabytes of scheduled-but-unconfirmed migrations to keep in flight. Accepts 1-100
1279
+ helpText: Max gigabytes of unconfirmed migrations to keep in flight (1-100)
1135
1280
  default: '50'
1136
1281
  # set-transition
1137
1282
  - name: set-transition
@@ -1139,7 +1284,9 @@ commands:
1139
1284
  replaced_by: 'tigris buckets lifecycle create <bucket> --storage-class <class> --days <N>'
1140
1285
  # lifecycle
1141
1286
  - name: lifecycle
1287
+ group: Configuration
1142
1288
  description: Manage bucket lifecycle rules. Each rule combines an optional storage-class transition and/or expiration (TTL), scoped to an optional key prefix
1289
+ helpText: Manage lifecycle rules (tier transitions and expiration)
1143
1290
  alias: lc
1144
1291
  examples:
1145
1292
  - "tigris buckets lifecycle list my-bucket"
@@ -1171,6 +1318,7 @@ commands:
1171
1318
  default: table
1172
1319
  - name: create
1173
1320
  description: Create a new lifecycle rule. A rule must include a transition (--storage-class with --days or --date) and/or an expiration (--expire-days or --expire-date), and may optionally be scoped via --prefix
1321
+ helpText: Create a lifecycle rule
1174
1322
  alias: c
1175
1323
  examples:
1176
1324
  - "tigris buckets lifecycle create my-bucket --storage-class STANDARD_IA --days 30"
@@ -1200,6 +1348,7 @@ commands:
1200
1348
  alias: d
1201
1349
  - name: date
1202
1350
  description: Transition objects on this date (ISO-8601, e.g. 2026-06-01) (used with --storage-class)
1351
+ helpText: Transition date, ISO-8601 (e.g. 2026-06-01). Used with --storage-class
1203
1352
  - name: expire-days
1204
1353
  description: Expire (delete) objects after this many days
1205
1354
  - name: expire-date
@@ -1209,6 +1358,7 @@ commands:
1209
1358
  type: flag
1210
1359
  - name: edit
1211
1360
  description: Edit an existing lifecycle rule by its id. Only specified fields are changed
1361
+ helpText: Edit a lifecycle rule by its id
1212
1362
  alias: e
1213
1363
  examples:
1214
1364
  - "tigris buckets lifecycle edit my-bucket abc123 --days 60"
@@ -1253,7 +1403,9 @@ commands:
1253
1403
  type: flag
1254
1404
  # set-notifications
1255
1405
  - name: set-notifications
1406
+ group: Configuration
1256
1407
  description: Configure object event notifications on a bucket. Sends webhook requests to a URL when objects are created, updated, or deleted
1408
+ helpText: Configure object event webhooks on a bucket
1257
1409
  examples:
1258
1410
  - "tigris buckets set-notifications my-bucket --url https://example.com/webhook"
1259
1411
  - "tigris buckets set-notifications my-bucket --url https://example.com/webhook --token secret123"
@@ -1297,7 +1449,9 @@ commands:
1297
1449
  type: flag
1298
1450
  # set-cors
1299
1451
  - name: set-cors
1452
+ group: Configuration
1300
1453
  description: Configure CORS rules on a bucket. Each invocation adds a rule unless --override or --reset is used
1454
+ helpText: Configure CORS rules on a bucket
1301
1455
  examples:
1302
1456
  - "tigris buckets set-cors my-bucket --origins '*' --methods GET,HEAD"
1303
1457
  - "tigris buckets set-cors my-bucket --origins https://example.com --methods GET,POST --headers Content-Type,Authorization --max-age 3600"
@@ -1335,7 +1489,9 @@ commands:
1335
1489
 
1336
1490
  # share
1337
1491
  - name: share
1492
+ group: Configuration
1338
1493
  description: Share a bucket with your whole organization, specific teams, or specific users. Existing shares are kept unless --override or --reset is used
1494
+ helpText: Share a bucket with your organization, teams, or users
1339
1495
  examples:
1340
1496
  - "tigris buckets share my-bucket --organization --role ReadOnly"
1341
1497
  - "tigris buckets share my-bucket --team tmid_MQQUhV --role Editor"
@@ -1357,18 +1513,22 @@ commands:
1357
1513
  - name: organization
1358
1514
  alias: org
1359
1515
  description: Give access to everyone in your organization. Takes exactly one --role and cannot be combined with --team or --user
1516
+ helpText: Share with your whole organization. Takes one --role; excludes --team/--user
1360
1517
  type: flag
1361
1518
  - name: team
1362
1519
  alias: t
1363
1520
  description: Team ID to share with (can specify multiple, comma-separated). Each team is paired positionally with a --role value
1521
+ helpText: Team ID(s), comma-separated. Each pairs positionally with a --role
1364
1522
  multiple: true
1365
1523
  - name: user
1366
1524
  alias: u
1367
1525
  description: User ID to share with (can specify multiple, comma-separated). Each user is paired positionally with a --role value
1526
+ helpText: User ID(s), comma-separated. Each pairs positionally with a --role
1368
1527
  multiple: true
1369
1528
  - name: role
1370
1529
  alias: r
1371
1530
  description: Role to grant (can specify multiple, comma-separated). A single role applies to every target; otherwise each role pairs with the corresponding --team or --user value
1531
+ helpText: Role(s) to grant, comma-separated. One role applies to every target
1372
1532
  multiple: true
1373
1533
  options:
1374
1534
  - ReadOnly
@@ -1393,7 +1553,9 @@ commands:
1393
1553
  # Manage snapshots
1394
1554
  #########################
1395
1555
  - name: snapshots
1556
+ group: Manage resources
1396
1557
  description: List, take, and delete snapshots. A snapshot is a point-in-time, read-only copy of a bucket's state
1558
+ helpText: List, take, and delete bucket snapshots
1397
1559
  alias: s
1398
1560
  examples:
1399
1561
  - "tigris snapshots list my-bucket"
@@ -1403,6 +1565,7 @@ commands:
1403
1565
  # list
1404
1566
  - name: list
1405
1567
  description: List all snapshots for the given bucket, ordered by creation time
1568
+ helpText: List a bucket's snapshots, ordered by creation time
1406
1569
  alias: l
1407
1570
  examples:
1408
1571
  - "tigris snapshots list my-bucket"
@@ -1431,6 +1594,7 @@ commands:
1431
1594
  # take
1432
1595
  - name: take
1433
1596
  description: Take a new snapshot of the bucket's current state. Optionally provide a name for the snapshot
1597
+ helpText: Take a snapshot of a bucket's current state
1434
1598
  alias: t
1435
1599
  examples:
1436
1600
  - "tigris snapshots take my-bucket"
@@ -1455,6 +1619,7 @@ commands:
1455
1619
  # delete
1456
1620
  - name: delete
1457
1621
  description: Delete one or more snapshots of a bucket by version. Deletion is permanent; forks already created from a snapshot are unaffected
1622
+ helpText: Permanently delete one or more snapshots
1458
1623
  alias: d
1459
1624
  examples:
1460
1625
  - "tigris snapshots delete my-bucket 1765889000501544464 --yes"
@@ -1467,6 +1632,7 @@ commands:
1467
1632
  - command: 'tigris snapshots list {{name}}'
1468
1633
  description: 'List remaining snapshots'
1469
1634
  arguments:
1635
+ - *yes_argument
1470
1636
  - name: name
1471
1637
  description: Name of the bucket
1472
1638
  type: positional
@@ -1475,6 +1641,7 @@ commands:
1475
1641
  - my-bucket
1476
1642
  - name: version
1477
1643
  description: Snapshot version, or comma separated list of versions. Find versions with "tigris snapshots list"
1644
+ helpText: Snapshot version(s), comma-separated. See "tigris snapshots list"
1478
1645
  type: positional
1479
1646
  required: true
1480
1647
  multiple: true
@@ -1490,7 +1657,10 @@ commands:
1490
1657
  # Manage objects
1491
1658
  #########################
1492
1659
  - name: objects
1660
+ group: Manage resources
1661
+ groups: [Basics, Versions & recovery, Archive]
1493
1662
  description: Low-level object operations for listing, downloading, uploading, and deleting individual objects in a bucket
1663
+ helpText: List, download, upload, and delete objects
1494
1664
  alias: o
1495
1665
  examples:
1496
1666
  - "tigris objects list my-bucket"
@@ -1501,7 +1671,9 @@ commands:
1501
1671
  commands:
1502
1672
  # list
1503
1673
  - name: list
1674
+ group: Basics
1504
1675
  description: List objects in a bucket, optionally filtered by a key prefix
1676
+ helpText: List objects in a bucket, optionally by key prefix
1505
1677
  alias: l
1506
1678
  examples:
1507
1679
  - "tigris objects list my-bucket"
@@ -1533,6 +1705,7 @@ commands:
1533
1705
  default: table
1534
1706
  - name: snapshot-version
1535
1707
  description: Read from a specific bucket snapshot. Accepts a snapshot version string or any UNIX nanosecond-precision timestamp (e.g. 1765889000501544464)
1708
+ helpText: Read from a bucket snapshot (version or UNIX nanosecond timestamp)
1536
1709
  alias: snapshot
1537
1710
  - name: limit
1538
1711
  description: Maximum number of items to return per page
@@ -1541,13 +1714,17 @@ commands:
1541
1714
  alias: pt
1542
1715
  - name: source
1543
1716
  description: List objects from a specific storage source on buckets with shadow migration enabled
1717
+ helpText: Storage source to list from on shadow-migration buckets
1544
1718
  options: [tigris, shadow]
1545
1719
  - name: deleted
1546
1720
  description: List soft-deleted objects instead of live ones. Requires soft delete on the bucket. On a snapshot bucket a plain delete records a delete marker instead, so use "tigris objects list-versions" for those
1721
+ helpText: List soft-deleted objects instead of live ones
1547
1722
  type: flag
1548
1723
  # list-versions
1549
1724
  - name: list-versions
1725
+ group: Versions & recovery
1550
1726
  description: List object versions and delete markers in a bucket (requires bucket versioning), or with --deleted the recoverable versions of soft-deleted objects. Returns both arrays separately to match the S3 ListObjectVersions response
1727
+ helpText: List object versions and delete markers
1551
1728
  alias: lv
1552
1729
  examples:
1553
1730
  - "tigris objects list-versions my-bucket"
@@ -1573,6 +1750,7 @@ commands:
1573
1750
  alias: p
1574
1751
  - name: delimiter
1575
1752
  description: Group keys sharing a common prefix up to the delimiter (e.g. "/" for folder-style grouping)
1753
+ helpText: Group keys by common prefix up to the delimiter (e.g. "/")
1576
1754
  alias: d
1577
1755
  - name: format
1578
1756
  description: Output format
@@ -1582,14 +1760,19 @@ commands:
1582
1760
  description: Maximum number of items to return per page
1583
1761
  - name: key-marker
1584
1762
  description: Pagination marker — the key to start listing from (from a prior nextKeyMarker)
1763
+ helpText: "Pagination marker: key to start from (a prior nextKeyMarker)"
1585
1764
  - name: version-id-marker
1586
1765
  description: Pagination marker — the version id to start listing from (from a prior nextVersionIdMarker)
1766
+ helpText: "Pagination marker: version id to start from (a prior nextVersionIdMarker)"
1587
1767
  - name: deleted
1588
1768
  description: List the recoverable versions of soft-deleted objects. Use the version id with "tigris objects restore-deleted" or "tigris objects purge"
1769
+ helpText: List the recoverable versions of soft-deleted objects
1589
1770
  type: flag
1590
1771
  # get
1591
1772
  - name: get
1773
+ group: Basics
1592
1774
  description: Download an object by key. Prints to stdout by default, or saves to a file with --output
1775
+ helpText: Download an object to stdout or a file
1593
1776
  alias: g
1594
1777
  examples:
1595
1778
  - "tigris objects get my-bucket config.json"
@@ -1617,16 +1800,21 @@ commands:
1617
1800
  alias: o
1618
1801
  - name: mode
1619
1802
  description: 'Response mode: "string" loads into memory, "stream" writes in chunks (auto-detected from extension if not specified)'
1803
+ helpText: "Response mode: string (in memory) or stream (chunked). Auto-detected"
1620
1804
  alias: m
1621
1805
  options: [string, stream]
1622
1806
  - name: snapshot-version
1623
1807
  description: Read from a specific bucket snapshot. Accepts a snapshot version string or any UNIX nanosecond-precision timestamp (e.g. 1765889000501544464)
1808
+ helpText: Read from a bucket snapshot (version or UNIX nanosecond timestamp)
1624
1809
  alias: snapshot
1625
1810
  - name: version-id
1626
1811
  description: Object version id to download (requires bucket versioning). Omit to download the latest version
1812
+ helpText: Object version id to download. Omit for the latest version
1627
1813
  # put
1628
1814
  - name: put
1815
+ group: Basics
1629
1816
  description: Upload a local file — or data piped via stdin — as an object. Content-type is auto-detected from the file extension unless overridden
1817
+ helpText: Upload a local file or stdin as an object
1630
1818
  alias: p
1631
1819
  examples:
1632
1820
  - "tigris objects put my-bucket report.pdf ./report.pdf"
@@ -1657,6 +1845,7 @@ commands:
1657
1845
  - my-file.txt
1658
1846
  - name: file
1659
1847
  description: Path to the local file to upload. Omit to read the object data from stdin (piped input)
1848
+ helpText: Local file to upload. Omit to read from stdin
1660
1849
  type: positional
1661
1850
  examples:
1662
1851
  - ./my-file.txt
@@ -1670,13 +1859,16 @@ commands:
1670
1859
  alias: t
1671
1860
  - name: cache-control
1672
1861
  description: Cache-Control header stored with the object and returned on every read (e.g. "public, max-age=31536000, immutable")
1862
+ helpText: Cache-Control header stored with the object and returned on reads
1673
1863
  - name: format
1674
1864
  description: Output format
1675
1865
  options: [json, table, xml]
1676
1866
  default: table
1677
1867
  # delete
1678
1868
  - name: delete
1869
+ group: Basics
1679
1870
  description: Delete one or more objects by key from the given bucket. On a versioned bucket, the default creates a delete marker; use --version-id or --all-versions to hard-delete versions
1871
+ helpText: Delete one or more objects by key
1680
1872
  alias: d
1681
1873
  examples:
1682
1874
  - "tigris objects delete my-bucket old-file.txt --yes"
@@ -1692,6 +1884,7 @@ commands:
1692
1884
  - command: 'tigris ls {{bucket}}'
1693
1885
  description: 'List remaining objects in the bucket'
1694
1886
  arguments:
1887
+ - *yes_argument
1695
1888
  - name: bucket
1696
1889
  description: Name of the bucket, or a full path (t3://bucket/key)
1697
1890
  type: positional
@@ -1701,21 +1894,26 @@ commands:
1701
1894
  - t3://my-bucket/old-file.txt
1702
1895
  - name: key
1703
1896
  description: Key of the object (comma separated for multiple, omit if bucket contains the full path)
1897
+ helpText: Object key(s), comma-separated. Omit if the bucket arg has the full path
1704
1898
  type: positional
1705
1899
  multiple: true
1706
1900
  examples:
1707
1901
  - my-file.txt
1708
1902
  - name: version-id
1709
1903
  description: Hard-delete a specific object version (requires bucket versioning). Targets a single key. To destroy a soft-deleted version, use "tigris objects purge"
1904
+ helpText: Hard-delete a specific object version (single key only)
1710
1905
  - name: all-versions
1711
1906
  description: Hard-delete every version and delete marker for the given key(s). Mutually exclusive with --version-id
1907
+ helpText: Hard-delete every version and delete marker. Excludes --version-id
1712
1908
  type: flag
1713
1909
  - name: force
1714
1910
  type: flag
1715
1911
  description: Skip confirmation prompts (alias for --yes)
1716
1912
  # set (deprecated)
1717
1913
  - name: set
1914
+ group: Basics
1718
1915
  description: (Deprecated) Update settings on an existing object such as access level. Use `tigris objects set-access` for ACL changes and `tigris mv` to rename
1916
+ helpText: (Deprecated) Update settings on an existing object
1719
1917
  alias: s
1720
1918
  deprecated: true
1721
1919
  examples:
@@ -1745,7 +1943,9 @@ commands:
1745
1943
  alias: n
1746
1944
  # set-access
1747
1945
  - name: set-access
1946
+ group: Basics
1748
1947
  description: Set the access level (public or private) on an existing object
1948
+ helpText: Set an object's access level (public or private)
1749
1949
  alias: sa
1750
1950
  examples:
1751
1951
  - "tigris objects set-access my-bucket my-file.txt public"
@@ -1764,6 +1964,7 @@ commands:
1764
1964
  type: positional
1765
1965
  - name: access
1766
1966
  description: Access level (public or private)
1967
+ helpText: Access level
1767
1968
  type: positional
1768
1969
  options: *access_options
1769
1970
  - name: format
@@ -1772,7 +1973,9 @@ commands:
1772
1973
  default: table
1773
1974
  # info
1774
1975
  - name: info
1976
+ group: Basics
1775
1977
  description: Show metadata for an object (content type, size, modified date)
1978
+ helpText: Show an object's content type, size, and modified date
1776
1979
  alias: i
1777
1980
  examples:
1778
1981
  - "tigris objects info my-bucket report.pdf"
@@ -1802,7 +2005,9 @@ commands:
1802
2005
  description: Object version id (requires bucket versioning). Omit to read the latest version
1803
2006
  # restore
1804
2007
  - name: restore
2008
+ group: Archive
1805
2009
  description: Restore an archived object (e.g. one in the GLACIER tier) into an actively-readable copy for a number of days
2010
+ helpText: Restore an archived object for a number of days
1806
2011
  alias: rs
1807
2012
  examples:
1808
2013
  - "tigris objects restore my-bucket archived.bin"
@@ -1823,12 +2028,15 @@ commands:
1823
2028
  description: Key of the object (omit if bucket contains the full path)
1824
2029
  - name: days
1825
2030
  description: How many days the restored copy stays available before reverting to its archived tier
2031
+ helpText: Days the restored copy stays available before re-archiving
1826
2032
  alias: d
1827
2033
  default: 1
1828
2034
  - name: version-id
1829
2035
  description: Restore a specific object version (requires bucket versioning). Omit to restore the current version
2036
+ helpText: Object version to restore. Omit for the current version
1830
2037
  - name: snapshot-version
1831
2038
  description: Restore the object as of a specific bucket snapshot. Accepts a snapshot version string or any UNIX nanosecond-precision timestamp (e.g. 1765889000501544464)
2039
+ helpText: Restore as of a bucket snapshot (version or UNIX nanosecond timestamp)
1832
2040
  alias: snapshot
1833
2041
  - name: format
1834
2042
  description: Output format
@@ -1836,7 +2044,9 @@ commands:
1836
2044
  default: table
1837
2045
  # restore-info
1838
2046
  - name: restore-info
2047
+ group: Archive
1839
2048
  description: Show the restore state of an archived object (archived, in-progress, or restored)
2049
+ helpText: Show the restore state of an archived object
1840
2050
  alias: ri
1841
2051
  examples:
1842
2052
  - "tigris objects restore-info my-bucket archived.bin"
@@ -1857,8 +2067,10 @@ commands:
1857
2067
  description: Key of the object (omit if bucket contains the full path)
1858
2068
  - name: version-id
1859
2069
  description: Inspect a specific object version (requires bucket versioning). Omit to read the current version
2070
+ helpText: Object version to inspect. Omit for the current version
1860
2071
  - name: snapshot-version
1861
2072
  description: Inspect the object as of a specific bucket snapshot. Accepts a snapshot version string or any UNIX nanosecond-precision timestamp (e.g. 1765889000501544464)
2073
+ helpText: Inspect as of a bucket snapshot (version or UNIX nanosecond timestamp)
1862
2074
  alias: snapshot
1863
2075
  - name: format
1864
2076
  description: Output format
@@ -1866,7 +2078,9 @@ commands:
1866
2078
  default: table
1867
2079
  # restore-deleted
1868
2080
  - name: restore-deleted
2081
+ group: Versions & recovery
1869
2082
  description: Restore a soft-deleted object within its retention window. List recoverable objects with "tigris objects list --deleted", then pick a version with "tigris objects list-versions --deleted"
2083
+ helpText: Restore a soft-deleted object
1870
2084
  alias: rd
1871
2085
  examples:
1872
2086
  - "tigris objects restore-deleted my-bucket report.pdf --version-id 1787749774802410496"
@@ -1894,13 +2108,16 @@ commands:
1894
2108
  - name: version-id
1895
2109
  required: true
1896
2110
  description: The soft-deleted version to bring back, from "tigris objects list-versions --deleted"
2111
+ helpText: Soft-deleted version to restore (see "objects list-versions --deleted")
1897
2112
  - name: format
1898
2113
  description: Output format
1899
2114
  options: [json, table, xml]
1900
2115
  default: table
1901
2116
  # purge
1902
2117
  - name: purge
2118
+ group: Versions & recovery
1903
2119
  description: Permanently destroy a soft-deleted object version before its retention period expires. This cannot be undone — the version can no longer be restored with "tigris objects restore-deleted"
2120
+ helpText: Permanently destroy a soft-deleted object version
1904
2121
  alias: pg
1905
2122
  examples:
1906
2123
  - "tigris objects purge my-bucket report.pdf --version-id 1787749774802410496 --yes"
@@ -1910,6 +2127,7 @@ commands:
1910
2127
  onSuccess: "Purged version '{{versionId}}' of '{{key}}'"
1911
2128
  onFailure: 'Failed to purge deleted object'
1912
2129
  arguments:
2130
+ - *yes_argument
1913
2131
  - name: bucket
1914
2132
  type: positional
1915
2133
  required: true
@@ -1925,6 +2143,7 @@ commands:
1925
2143
  - name: version-id
1926
2144
  required: true
1927
2145
  description: The soft-deleted version to destroy, from "tigris objects list-versions --deleted"
2146
+ helpText: Soft-deleted version to destroy (see "objects list-versions --deleted")
1928
2147
  - name: force
1929
2148
  type: flag
1930
2149
  description: Skip confirmation prompts (alias for --yes)
@@ -1937,11 +2156,13 @@ commands:
1937
2156
  # Manage access keys
1938
2157
  #########################
1939
2158
  - name: access-keys
2159
+ group: Manage resources
1940
2160
  description: Create, list, inspect, delete, and assign roles to access keys. Access keys are credentials used for programmatic API access
2161
+ helpText: Manage access keys and their bucket roles
1941
2162
  alias: keys
1942
2163
  examples:
1943
2164
  - "tigris access-keys list"
1944
- - "tigris access-keys create my-ci-key"
2165
+ - "tigris access-keys create my-app --bucket my-app-bucket --role Editor --env"
1945
2166
  - "tigris access-keys assign tid_AaBb --bucket my-bucket --role Editor"
1946
2167
  commands:
1947
2168
  - name: list
@@ -1965,10 +2186,13 @@ commands:
1965
2186
  description: Pagination token from a previous request to fetch the next page
1966
2187
  alias: pt
1967
2188
  - name: create
1968
- description: Create a new access key with the given name. Returns the key ID and secret (shown only once)
2189
+ description: Create a new access key, optionally scoped to buckets, and export its credentials to a dotenv file or your shell. Returns the key ID and secret (shown only once)
2190
+ helpText: Create a new access key and export its credentials
1969
2191
  alias: c
1970
2192
  examples:
1971
2193
  - "tigris access-keys create my-ci-key"
2194
+ - "tigris access-keys create my-app --bucket my-app-bucket --role Editor --env"
2195
+ - 'eval "$(tigris access-keys create dev --bucket my-app-bucket --role Editor --export)"'
1972
2196
  messages:
1973
2197
  onStart: 'Creating access key...'
1974
2198
  onSuccess: 'Access key created'
@@ -1983,8 +2207,24 @@ commands:
1983
2207
  required: true
1984
2208
  examples:
1985
2209
  - my-key
2210
+ - *key_bucket_argument
2211
+ - *key_role_argument
2212
+ - *key_admin_argument
2213
+ - name: env
2214
+ description: Write the credentials to a dotenv file, merging into it when it already exists. Defaults to ./.env. The secret is then not printed
2215
+ helpText: Write the credentials to a dotenv file (default ./.env)
2216
+ - name: export
2217
+ type: flag
2218
+ description: Print the credentials as shell "export" lines and nothing else on stdout, for eval "$(tigris access-keys create <name> --export)"
2219
+ helpText: Print shell "export" lines for eval "$(...)"
2220
+ - name: for
2221
+ description: Which SDK the credentials are for. --env and --export then use that SDK's variable names. tigris writes TIGRIS_STORAGE_*; aws writes AWS_* plus Tigris endpoints and region
2222
+ helpText: SDK the variables are named for (with --env or --export)
2223
+ options: [tigris, aws]
2224
+ default: tigris
1986
2225
  - name: delete
1987
2226
  description: Permanently delete an access key by its ID. This revokes all access immediately
2227
+ helpText: Permanently delete an access key
1988
2228
  alias: d
1989
2229
  examples:
1990
2230
  - "tigris access-keys delete tid_AaBbCcDdEeFf --yes"
@@ -1993,6 +2233,7 @@ commands:
1993
2233
  onSuccess: 'Access key deleted'
1994
2234
  onFailure: 'Failed to delete access key'
1995
2235
  arguments:
2236
+ - *yes_argument
1996
2237
  - name: id
1997
2238
  description: Access key ID
1998
2239
  type: positional
@@ -2004,6 +2245,7 @@ commands:
2004
2245
  description: Skip confirmation prompts (alias for --yes)
2005
2246
  - name: get
2006
2247
  description: Show details for an access key including its name, creation date, and assigned bucket roles
2248
+ helpText: Show an access key's details and bucket roles
2007
2249
  alias: g
2008
2250
  examples:
2009
2251
  - "tigris access-keys get tid_AaBbCcDdEeFf"
@@ -2020,6 +2262,7 @@ commands:
2020
2262
  - tid_AaBbCcDdEeFf
2021
2263
  - name: assign
2022
2264
  description: Assign per-bucket roles to an access key. Pair each --bucket with a --role (Editor, ReadWrite, or ReadOnly), or use --admin for org-wide access
2265
+ helpText: Assign per-bucket roles to an access key
2023
2266
  alias: a
2024
2267
  examples:
2025
2268
  - "tigris access-keys assign tid_AaBb --bucket my-bucket --role Editor"
@@ -2040,26 +2283,15 @@ commands:
2040
2283
  required: true
2041
2284
  examples:
2042
2285
  - tid_AaBbCcDdEeFf
2043
- - name: bucket
2044
- alias: b
2045
- description: Bucket name (can specify multiple, comma-separated). Each bucket is paired positionally with a --role value
2046
- multiple: true
2047
- - name: role
2048
- alias: r
2049
- description: Role to assign (can specify multiple, comma-separated). Each role pairs with the corresponding --bucket value
2050
- multiple: true
2051
- options:
2052
- - Editor
2053
- - ReadWrite
2054
- - ReadOnly
2055
- - name: admin
2056
- description: Grant admin access to all buckets in the organization
2057
- type: flag
2286
+ - *key_bucket_argument
2287
+ - *key_role_argument
2288
+ - *key_admin_argument
2058
2289
  - name: revoke-roles
2059
2290
  description: Revoke all bucket roles from the access key
2060
2291
  type: flag
2061
2292
  - name: rotate
2062
2293
  description: Rotate an access key's secret. The current secret is immediately invalidated and a new one is returned (shown only once)
2294
+ helpText: Rotate an access key's secret
2063
2295
  alias: r
2064
2296
  examples:
2065
2297
  - "tigris access-keys rotate tid_AaBbCcDdEeFf --yes"
@@ -2071,6 +2303,7 @@ commands:
2071
2303
  - command: 'tigris access-keys get {{id}}'
2072
2304
  description: 'Verify the rotated access key'
2073
2305
  arguments:
2306
+ - *yes_argument
2074
2307
  - name: id
2075
2308
  description: Access key ID
2076
2309
  type: positional
@@ -2082,6 +2315,7 @@ commands:
2082
2315
  description: Skip confirmation prompts (alias for --yes)
2083
2316
  - name: attach-policy
2084
2317
  description: Attach an IAM policy to an access key. If no policy ARN is provided, shows interactive selection of available policies
2318
+ helpText: Attach an IAM policy to an access key
2085
2319
  alias: ap
2086
2320
  examples:
2087
2321
  - "tigris access-keys attach-policy tid_AaBb --policy-arn arn:aws:iam::org_id:policy/my-policy"
@@ -2103,6 +2337,7 @@ commands:
2103
2337
  - arn:aws:iam::org_id:policy/my-policy
2104
2338
  - name: detach-policy
2105
2339
  description: Detach an IAM policy from an access key. If no policy ARN is provided, shows interactive selection of attached policies
2340
+ helpText: Detach an IAM policy from an access key
2106
2341
  alias: dp
2107
2342
  examples:
2108
2343
  - "tigris access-keys detach-policy tid_AaBb --policy-arn arn:aws:iam::org_id:policy/my-policy --yes"
@@ -2112,6 +2347,7 @@ commands:
2112
2347
  onSuccess: 'Policy detached'
2113
2348
  onFailure: 'Failed to detach policy'
2114
2349
  arguments:
2350
+ - *yes_argument
2115
2351
  - name: id
2116
2352
  description: Access key ID
2117
2353
  type: positional
@@ -2156,7 +2392,9 @@ commands:
2156
2392
  # IAM - Identity and Access Management
2157
2393
  #########################
2158
2394
  - name: iam
2395
+ group: Manage resources
2159
2396
  description: Identity and Access Management - manage policies, users, and permissions
2397
+ helpText: Manage IAM policies, users, and teams
2160
2398
  examples:
2161
2399
  - "tigris iam policies list"
2162
2400
  - "tigris iam policies create my-policy --document policy.json"
@@ -2165,6 +2403,7 @@ commands:
2165
2403
  commands:
2166
2404
  - name: policies
2167
2405
  description: Manage IAM policies. Policies define permissions for access keys
2406
+ helpText: Manage IAM policies
2168
2407
  alias: p
2169
2408
  examples:
2170
2409
  - "tigris iam policies list"
@@ -2192,6 +2431,7 @@ commands:
2192
2431
  alias: pt
2193
2432
  - name: get
2194
2433
  description: Show details for a policy including its document and attached users. If no ARN provided, shows interactive selection
2434
+ helpText: Show a policy's document and attached users
2195
2435
  alias: g
2196
2436
  examples:
2197
2437
  - "tigris iam policies get"
@@ -2214,6 +2454,7 @@ commands:
2214
2454
  default: table
2215
2455
  - name: create
2216
2456
  description: Create a new policy with the given name and policy document. Document can be provided via file, inline JSON, or stdin
2457
+ helpText: Create a policy from a file, inline JSON, or stdin
2217
2458
  alias: c
2218
2459
  examples:
2219
2460
  - "tigris iam policies create my-policy --document policy.json"
@@ -2232,12 +2473,14 @@ commands:
2232
2473
  - my-policy
2233
2474
  - name: document
2234
2475
  description: Policy document (JSON file path or inline JSON). If omitted, reads from stdin
2476
+ helpText: Policy document (JSON file or inline JSON). Omit to read stdin
2235
2477
  alias: d
2236
2478
  required: false
2237
2479
  - name: description
2238
2480
  description: Policy description
2239
2481
  - name: edit
2240
2482
  description: Update an existing policy's document. Document can be provided via file, inline JSON, or stdin. If no ARN provided, shows interactive selection
2483
+ helpText: Update an existing policy's document
2241
2484
  alias: e
2242
2485
  examples:
2243
2486
  - "tigris iam policies edit --document policy.json"
@@ -2257,6 +2500,7 @@ commands:
2257
2500
  - arn:aws:iam::org_id:policy/my-policy
2258
2501
  - name: document
2259
2502
  description: New policy document (JSON file path or inline JSON). If omitted, reads from stdin
2503
+ helpText: New policy document (JSON file or inline JSON). Omit to read stdin
2260
2504
  alias: d
2261
2505
  required: false
2262
2506
  - name: description
@@ -2264,6 +2508,7 @@ commands:
2264
2508
  required: false
2265
2509
  - name: delete
2266
2510
  description: Delete a policy. If no ARN provided, shows interactive selection
2511
+ helpText: Delete a policy
2267
2512
  alias: d
2268
2513
  examples:
2269
2514
  - "tigris iam policies delete"
@@ -2274,6 +2519,7 @@ commands:
2274
2519
  onFailure: 'Failed to delete policy'
2275
2520
  onEmpty: 'No policies found'
2276
2521
  arguments:
2522
+ - *yes_argument
2277
2523
  - name: resource
2278
2524
  description: Policy ARN. If omitted, shows interactive selection
2279
2525
  type: positional
@@ -2285,6 +2531,7 @@ commands:
2285
2531
  description: Skip confirmation prompts (alias for --yes)
2286
2532
  - name: link-key
2287
2533
  description: Link an access key to a policy. If no policy ARN is provided, shows interactive selection. If no access key ID is provided, shows interactive selection of unlinked keys
2534
+ helpText: Link an access key to a policy
2288
2535
  alias: lnk
2289
2536
  examples:
2290
2537
  - "tigris iam policies link-key arn:aws:iam::org_id:policy/my-policy --id tid_AaBb"
@@ -2307,6 +2554,7 @@ commands:
2307
2554
  - tid_AaBbCcDdEeFf
2308
2555
  - name: unlink-key
2309
2556
  description: Unlink an access key from a policy. If no policy ARN is provided, shows interactive selection. If no access key ID is provided, shows interactive selection of linked keys
2557
+ helpText: Unlink an access key from a policy
2310
2558
  alias: ulnk
2311
2559
  examples:
2312
2560
  - "tigris iam policies unlink-key arn:aws:iam::org_id:policy/my-policy --id tid_AaBb --yes"
@@ -2317,6 +2565,7 @@ commands:
2317
2565
  onFailure: 'Failed to unlink access key'
2318
2566
  onEmpty: 'No policies found'
2319
2567
  arguments:
2568
+ - *yes_argument
2320
2569
  - name: resource
2321
2570
  description: Policy ARN. If omitted, shows interactive selection
2322
2571
  type: positional
@@ -2332,6 +2581,7 @@ commands:
2332
2581
  description: Skip confirmation prompts (alias for --yes)
2333
2582
  - name: list-keys
2334
2583
  description: List all access keys attached to a policy. If no policy ARN is provided, shows interactive selection
2584
+ helpText: List the access keys attached to a policy
2335
2585
  alias: lk
2336
2586
  examples:
2337
2587
  - "tigris iam policies list-keys arn:aws:iam::org_id:policy/my-policy"
@@ -2404,6 +2654,7 @@ commands:
2404
2654
  default: member
2405
2655
  - name: revoke-invitation
2406
2656
  description: Revoke pending invitations. If no invitation ID provided, shows interactive selection
2657
+ helpText: Revoke pending invitations
2407
2658
  alias: ri
2408
2659
  examples:
2409
2660
  - "tigris iam users revoke-invitation"
@@ -2415,8 +2666,10 @@ commands:
2415
2666
  onFailure: 'Failed to revoke invitation'
2416
2667
  onEmpty: 'No pending invitations found'
2417
2668
  arguments:
2669
+ - *yes_argument
2418
2670
  - name: resource
2419
2671
  description: Invitation ID(s) (comma-separated for multiple). If omitted, shows interactive selection
2672
+ helpText: Invitation ID(s), comma-separated. Omit to select interactively
2420
2673
  type: positional
2421
2674
  required: false
2422
2675
  multiple: true
@@ -2425,6 +2678,7 @@ commands:
2425
2678
  description: Skip confirmation prompts (alias for --yes)
2426
2679
  - name: update-role
2427
2680
  description: Update user roles in the organization. If no user ID provided, shows interactive selection
2681
+ helpText: Update user roles in the organization
2428
2682
  alias: ur
2429
2683
  examples:
2430
2684
  - "tigris iam users update-role --role admin"
@@ -2439,17 +2693,20 @@ commands:
2439
2693
  arguments:
2440
2694
  - name: resource
2441
2695
  description: User ID(s) (comma-separated for multiple). If omitted, shows interactive selection
2696
+ helpText: User ID(s), comma-separated. Omit to select interactively
2442
2697
  type: positional
2443
2698
  required: false
2444
2699
  multiple: true
2445
2700
  - name: role
2446
2701
  description: Role(s) to assign (comma-separated). Each role pairs with the corresponding user ID. If one role is given, it applies to all users
2702
+ helpText: Role(s), comma-separated. One role applies to all users
2447
2703
  alias: r
2448
2704
  required: true
2449
2705
  options: [admin, member]
2450
2706
  multiple: true
2451
2707
  - name: remove
2452
2708
  description: Remove users from the organization. If no user ID provided, shows interactive selection
2709
+ helpText: Remove users from the organization
2453
2710
  alias: rm
2454
2711
  examples:
2455
2712
  - "tigris iam users remove"
@@ -2461,8 +2718,10 @@ commands:
2461
2718
  onFailure: 'Failed to remove user'
2462
2719
  onEmpty: 'No users found in this organization'
2463
2720
  arguments:
2721
+ - *yes_argument
2464
2722
  - name: resource
2465
2723
  description: User ID(s) (comma-separated for multiple). If omitted, shows interactive selection
2724
+ helpText: User ID(s), comma-separated. Omit to select interactively
2466
2725
  type: positional
2467
2726
  required: false
2468
2727
  multiple: true
@@ -2520,6 +2779,7 @@ commands:
2520
2779
  multiple: true
2521
2780
  - name: edit
2522
2781
  description: Update a team's name, description, or members. Members are replaced with the provided list
2782
+ helpText: Update a team's name, description, or members
2523
2783
  alias: e
2524
2784
  examples:
2525
2785
  - "tigris iam teams edit team_id --name platform"
@@ -2542,5 +2802,6 @@ commands:
2542
2802
  alias: d
2543
2803
  - name: members
2544
2804
  description: Replace the team's members with these email address(es) (comma-separated for multiple)
2805
+ helpText: Member email(s), comma-separated. Replaces the current members
2545
2806
  alias: m
2546
2807
  multiple: true