@tigrisdata/cli 3.12.1 → 3.13.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 (132) hide show
  1. package/README.md +33 -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 +456 -193
  6. package/dist/{chunk-X2SUXPXB.js → chunk-453SVRXR.js} +1 -1
  7. package/dist/chunk-CIRQB45N.js +7 -0
  8. package/dist/{chunk-6RSONDY2.js → chunk-DBLI36XY.js} +1 -1
  9. package/dist/{chunk-IUIKP2LU.js → chunk-EOCLTUJ4.js} +1 -1
  10. package/dist/chunk-FVHGLZAE.js +1 -0
  11. package/dist/chunk-IA7SF576.js +2 -0
  12. package/dist/{chunk-C4WTV2YM.js → chunk-IOTP5CCJ.js} +1 -1
  13. package/dist/chunk-JF2D6OZD.js +4 -0
  14. package/dist/{chunk-XBMAJWHH.js → chunk-KKSYGHZK.js} +1 -1
  15. package/dist/{chunk-NOYGN74P.js → chunk-P2MUSPB4.js} +1 -1
  16. package/dist/{chunk-JKIAWSHG.js → chunk-PHN3GNLG.js} +1 -1
  17. package/dist/chunk-QCASVW5M.js +3 -0
  18. package/dist/chunk-RZMWZYTK.js +1 -0
  19. package/dist/chunk-S447CUNB.js +1 -0
  20. package/dist/{chunk-OIOEFM6D.js → chunk-TZ7BKFW5.js} +1 -1
  21. package/dist/{chunk-4GODDZ6W.js → chunk-VFRTC4TW.js} +1 -1
  22. package/dist/{chunk-ARZLX6CN.js → chunk-VSUYES3O.js} +1 -1
  23. package/dist/chunk-Y36SHW6I.js +14 -0
  24. package/dist/{chunk-YXNJDI2L.js → chunk-Y4FIJDZ4.js} +1 -1
  25. package/dist/chunk-ZC272QWP.js +5 -0
  26. package/dist/cli-core.js +1 -1
  27. package/dist/cli.js +1 -1
  28. package/dist/help.js +1 -0
  29. package/dist/index.js +1 -1
  30. package/dist/lib/access-keys/assign.js +1 -1
  31. package/dist/lib/access-keys/attach-policy.js +1 -1
  32. package/dist/lib/access-keys/create.js +2 -1
  33. package/dist/lib/access-keys/delete.js +1 -1
  34. package/dist/lib/access-keys/detach-policy.js +1 -1
  35. package/dist/lib/access-keys/get.js +1 -1
  36. package/dist/lib/access-keys/list-policies.js +1 -1
  37. package/dist/lib/access-keys/list.js +1 -1
  38. package/dist/lib/access-keys/roles.js +1 -0
  39. package/dist/lib/access-keys/rotate.js +1 -1
  40. package/dist/lib/buckets/create.js +1 -1
  41. package/dist/lib/buckets/delete.js +1 -1
  42. package/dist/lib/buckets/disable-snapshots.js +1 -1
  43. package/dist/lib/buckets/enable-snapshots.js +1 -1
  44. package/dist/lib/buckets/get.js +1 -1
  45. package/dist/lib/buckets/lifecycle/create.js +1 -1
  46. package/dist/lib/buckets/lifecycle/edit.js +1 -1
  47. package/dist/lib/buckets/lifecycle/list.js +1 -1
  48. package/dist/lib/buckets/lifecycle/shared.js +1 -1
  49. package/dist/lib/buckets/list.js +1 -1
  50. package/dist/lib/buckets/merge.js +1 -1
  51. package/dist/lib/buckets/migrate.js +1 -1
  52. package/dist/lib/buckets/rebase.js +1 -1
  53. package/dist/lib/buckets/restore.js +1 -1
  54. package/dist/lib/buckets/set-cors.js +1 -1
  55. package/dist/lib/buckets/set-locations.js +1 -1
  56. package/dist/lib/buckets/set-migration.js +1 -1
  57. package/dist/lib/buckets/set-notifications.js +1 -1
  58. package/dist/lib/buckets/set.js +1 -1
  59. package/dist/lib/buckets/share.js +1 -1
  60. package/dist/lib/bundle.js +1 -1
  61. package/dist/lib/configure/index.js +1 -1
  62. package/dist/lib/cp.js +1 -1
  63. package/dist/lib/credentials/test.js +1 -1
  64. package/dist/lib/iam/policies/create.js +1 -1
  65. package/dist/lib/iam/policies/delete.js +1 -1
  66. package/dist/lib/iam/policies/edit.js +1 -1
  67. package/dist/lib/iam/policies/get.js +1 -1
  68. package/dist/lib/iam/policies/link-key.js +1 -1
  69. package/dist/lib/iam/policies/list-keys.js +1 -1
  70. package/dist/lib/iam/policies/list.js +1 -1
  71. package/dist/lib/iam/policies/select-policy.js +1 -1
  72. package/dist/lib/iam/policies/unlink-key.js +1 -1
  73. package/dist/lib/iam/policies/utils.js +1 -1
  74. package/dist/lib/iam/teams/create.js +1 -1
  75. package/dist/lib/iam/teams/edit.js +1 -1
  76. package/dist/lib/iam/teams/list.js +1 -1
  77. package/dist/lib/iam/teams/shared.js +1 -1
  78. package/dist/lib/iam/users/invite.js +1 -1
  79. package/dist/lib/iam/users/list.js +1 -1
  80. package/dist/lib/iam/users/remove.js +1 -1
  81. package/dist/lib/iam/users/revoke-invitation.js +1 -1
  82. package/dist/lib/iam/users/update-role.js +1 -1
  83. package/dist/lib/init/index.js +1 -1
  84. package/dist/lib/init/plan.js +1 -1
  85. package/dist/lib/login/credentials.js +1 -1
  86. package/dist/lib/login/oauth.js +1 -1
  87. package/dist/lib/login/select.js +1 -1
  88. package/dist/lib/logout.js +1 -1
  89. package/dist/lib/ls.js +1 -1
  90. package/dist/lib/mk.js +1 -1
  91. package/dist/lib/mv.js +1 -1
  92. package/dist/lib/objects/delete.js +1 -1
  93. package/dist/lib/objects/get.js +1 -1
  94. package/dist/lib/objects/info.js +1 -1
  95. package/dist/lib/objects/list-versions.js +1 -1
  96. package/dist/lib/objects/list.js +1 -1
  97. package/dist/lib/objects/purge.js +1 -1
  98. package/dist/lib/objects/put.js +1 -1
  99. package/dist/lib/objects/restore-deleted.js +1 -1
  100. package/dist/lib/objects/restore-info.js +1 -1
  101. package/dist/lib/objects/restore.js +1 -1
  102. package/dist/lib/objects/set-access.js +1 -1
  103. package/dist/lib/objects/set.js +1 -1
  104. package/dist/lib/organizations/create.js +1 -1
  105. package/dist/lib/organizations/list.js +1 -1
  106. package/dist/lib/organizations/select.js +1 -1
  107. package/dist/lib/presign.js +1 -1
  108. package/dist/lib/rm.js +1 -1
  109. package/dist/lib/snapshots/delete.js +1 -1
  110. package/dist/lib/snapshots/list.js +1 -1
  111. package/dist/lib/snapshots/take.js +1 -1
  112. package/dist/lib/stat.js +1 -1
  113. package/dist/lib/telemetry/disable.js +1 -1
  114. package/dist/lib/telemetry/enable.js +1 -1
  115. package/dist/lib/telemetry/status.js +1 -1
  116. package/dist/lib/touch.js +1 -1
  117. package/dist/lib/update.js +1 -1
  118. package/dist/lib/whoami.js +1 -1
  119. package/dist/specs.yaml +272 -19
  120. package/dist/utils/analytics.js +1 -1
  121. package/dist/utils/bucket-info.js +1 -1
  122. package/dist/utils/credentials-export.js +1 -0
  123. package/dist/utils/exit.js +1 -1
  124. package/dist/utils/telemetry.js +1 -1
  125. package/dist/utils/update-check.js +1 -1
  126. package/package.json +2 -2
  127. package/dist/chunk-E6COPYXK.js +0 -28
  128. package/dist/chunk-HEQX2NUJ.js +0 -2
  129. package/dist/chunk-KWYDYEDO.js +0 -5
  130. package/dist/chunk-TUDALPGD.js +0 -1
  131. package/dist/chunk-VXGFGLXP.js +0 -10
  132. package/dist/chunk-ZJWJRAFY.js +0 -1
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,6 +845,7 @@ 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:
@@ -769,7 +875,9 @@ commands:
769
875
  alias: pt
770
876
  # create
771
877
  - name: create
878
+ group: Basics
772
879
  description: Create a new bucket with optional access, tier, and location settings
880
+ helpText: Create a new bucket
773
881
  alias: c
774
882
  examples:
775
883
  - "tigris buckets create my-bucket"
@@ -839,10 +947,13 @@ commands:
839
947
  alias: fork
840
948
  - name: source-snapshot
841
949
  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
950
+ helpText: Fork from this snapshot (version or UNIX ns timestamp). Requires --fork-of
842
951
  alias: source-snap
843
952
  # rebase
844
953
  - name: rebase
954
+ group: Forks & snapshots
845
955
  description: Update a fork with the latest changes from its source bucket
956
+ helpText: Update a fork with its source bucket's latest changes
846
957
  examples:
847
958
  - "tigris buckets rebase my-fork"
848
959
  - "tigris buckets rebase my-fork --yes"
@@ -854,6 +965,7 @@ commands:
854
965
  - command: 'tigris buckets merge {{fork}}'
855
966
  description: "Merge the fork's changes back into its source bucket"
856
967
  arguments:
968
+ - *yes_argument
857
969
  - name: fork
858
970
  description: Name of the fork bucket to rebase onto its source
859
971
  type: positional
@@ -862,6 +974,7 @@ commands:
862
974
  - my-fork
863
975
  # merge
864
976
  - name: merge
977
+ group: Forks & snapshots
865
978
  description: Merge a fork's changes back into its source bucket
866
979
  examples:
867
980
  - "tigris buckets merge my-fork"
@@ -876,6 +989,7 @@ commands:
876
989
  - command: 'tigris buckets get {{into}}'
877
990
  description: 'Inspect the updated source bucket'
878
991
  arguments:
992
+ - *yes_argument
879
993
  - name: fork
880
994
  description: Name of the fork bucket whose changes will be merged
881
995
  type: positional
@@ -887,10 +1001,13 @@ commands:
887
1001
  alias: source
888
1002
  - name: from-snapshot
889
1003
  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)
1004
+ helpText: Merge from a snapshot of the fork (version or UNIX nanosecond timestamp)
890
1005
  alias: from-snap
891
1006
  # get
892
1007
  - name: get
1008
+ group: Basics
893
1009
  description: Show details for a bucket including access level, region, tier, and custom domain
1010
+ helpText: Show a bucket's access level, region, tier, and domain
894
1011
  alias: g
895
1012
  examples:
896
1013
  - "tigris buckets get my-bucket"
@@ -911,7 +1028,9 @@ commands:
911
1028
  default: table
912
1029
  # delete
913
1030
  - name: delete
1031
+ group: Basics
914
1032
  description: Delete one or more buckets by name. The bucket must be empty or delete-protection must be off
1033
+ helpText: Delete one or more buckets
915
1034
  alias: d
916
1035
  examples:
917
1036
  - "tigris buckets delete my-bucket --yes"
@@ -924,6 +1043,7 @@ commands:
924
1043
  - command: 'tigris ls'
925
1044
  description: 'List remaining buckets'
926
1045
  arguments:
1046
+ - *yes_argument
927
1047
  - name: name
928
1048
  description: Name of the bucket or comma separated list of buckets
929
1049
  type: positional
@@ -936,7 +1056,9 @@ commands:
936
1056
  description: Skip confirmation prompts (alias for --yes)
937
1057
  # restore
938
1058
  - name: restore
1059
+ group: Basics
939
1060
  description: Restore a soft-deleted bucket within its retention window. List recoverable buckets with "tigris buckets list --deleted"
1061
+ helpText: Restore a soft-deleted bucket
940
1062
  examples:
941
1063
  - "tigris buckets restore my-bucket"
942
1064
  messages:
@@ -955,7 +1077,9 @@ commands:
955
1077
  - my-bucket
956
1078
  # set
957
1079
  - name: set
1080
+ group: Basics
958
1081
  description: Update settings on an existing bucket such as access level, default tier, location, caching, or custom domain
1082
+ helpText: Update settings on an existing bucket
959
1083
  alias: s
960
1084
  examples:
961
1085
  - "tigris buckets set my-bucket --access public"
@@ -986,6 +1110,7 @@ commands:
986
1110
  replaced_by: --locations
987
1111
  - name: locations
988
1112
  description: Bucket location (see https://www.tigrisdata.com/docs/buckets/locations/ for more details)
1113
+ helpText: Bucket location(s), comma-separated
989
1114
  options: *location_options
990
1115
  multiple: true
991
1116
  - name: allow-object-acl
@@ -1005,15 +1130,19 @@ commands:
1005
1130
  replaced_by: --soft-delete
1006
1131
  - name: soft-delete
1007
1132
  description: Enable or disable soft delete (recoverable deletes). Requires --retention-days when enabling
1133
+ helpText: Enable or disable soft delete. Enabling requires --retention-days
1008
1134
  options: [enable, disable]
1009
1135
  - name: retention-days
1010
1136
  description: Number of days to retain soft-deleted objects (required when enabling --soft-delete)
1137
+ helpText: Days to retain soft-deleted objects (required when enabling soft delete)
1011
1138
  - name: enable-additional-headers
1012
1139
  description: Enable additional HTTP headers (X-Content-Type-Options nosniff)
1013
1140
  type: boolean
1014
1141
  # enable-snapshots
1015
1142
  - name: enable-snapshots
1143
+ group: Forks & snapshots
1016
1144
  description: Enable snapshots on an existing bucket, converting it to a snapshot bucket
1145
+ helpText: Enable snapshots on an existing bucket
1017
1146
  examples:
1018
1147
  - "tigris buckets enable-snapshots my-bucket"
1019
1148
  messages:
@@ -1029,7 +1158,9 @@ commands:
1029
1158
  - my-bucket
1030
1159
  # disable-snapshots
1031
1160
  - name: disable-snapshots
1161
+ group: Forks & snapshots
1032
1162
  description: Disable snapshots on an existing bucket, converting it back to a regular bucket. Rejected while the bucket has dependent forks
1163
+ helpText: Disable snapshots on an existing bucket
1033
1164
  examples:
1034
1165
  - "tigris buckets disable-snapshots my-bucket"
1035
1166
  messages:
@@ -1049,6 +1180,7 @@ commands:
1049
1180
  replaced_by: 'tigris buckets lifecycle create <bucket> --expire-days <N>'
1050
1181
  # set-locations
1051
1182
  - name: set-locations
1183
+ group: Configuration
1052
1184
  description: Set the data locations for a bucket
1053
1185
  examples:
1054
1186
  - "tigris buckets set-locations my-bucket --locations iad"
@@ -1072,7 +1204,9 @@ commands:
1072
1204
  multiple: true
1073
1205
  # set-migration
1074
1206
  - name: set-migration
1207
+ group: Migration
1075
1208
  description: Configure data migration from an external S3-compatible source bucket. Tigris will pull objects on demand from the source
1209
+ helpText: Configure on-demand migration from an S3-compatible bucket
1076
1210
  examples:
1077
1211
  - "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
1212
  - "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 +1245,9 @@ commands:
1111
1245
  type: flag
1112
1246
  # migrate
1113
1247
  - name: migrate
1248
+ group: Migration
1114
1249
  description: Actively migrate all objects from a shadow bucket to Tigris by scheduling server-side migration for unmigrated objects
1250
+ helpText: Actively migrate all objects from a shadow bucket
1115
1251
  examples:
1116
1252
  - "tigris buckets migrate my-bucket"
1117
1253
  - "tigris buckets migrate my-bucket/images/"
@@ -1132,6 +1268,7 @@ commands:
1132
1268
  - t3://my-bucket/prefix/
1133
1269
  - name: max-in-flight-gb
1134
1270
  description: Max total gigabytes of scheduled-but-unconfirmed migrations to keep in flight. Accepts 1-100
1271
+ helpText: Max gigabytes of unconfirmed migrations to keep in flight (1-100)
1135
1272
  default: '50'
1136
1273
  # set-transition
1137
1274
  - name: set-transition
@@ -1139,7 +1276,9 @@ commands:
1139
1276
  replaced_by: 'tigris buckets lifecycle create <bucket> --storage-class <class> --days <N>'
1140
1277
  # lifecycle
1141
1278
  - name: lifecycle
1279
+ group: Configuration
1142
1280
  description: Manage bucket lifecycle rules. Each rule combines an optional storage-class transition and/or expiration (TTL), scoped to an optional key prefix
1281
+ helpText: Manage lifecycle rules (tier transitions and expiration)
1143
1282
  alias: lc
1144
1283
  examples:
1145
1284
  - "tigris buckets lifecycle list my-bucket"
@@ -1171,6 +1310,7 @@ commands:
1171
1310
  default: table
1172
1311
  - name: create
1173
1312
  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
1313
+ helpText: Create a lifecycle rule
1174
1314
  alias: c
1175
1315
  examples:
1176
1316
  - "tigris buckets lifecycle create my-bucket --storage-class STANDARD_IA --days 30"
@@ -1200,6 +1340,7 @@ commands:
1200
1340
  alias: d
1201
1341
  - name: date
1202
1342
  description: Transition objects on this date (ISO-8601, e.g. 2026-06-01) (used with --storage-class)
1343
+ helpText: Transition date, ISO-8601 (e.g. 2026-06-01). Used with --storage-class
1203
1344
  - name: expire-days
1204
1345
  description: Expire (delete) objects after this many days
1205
1346
  - name: expire-date
@@ -1209,6 +1350,7 @@ commands:
1209
1350
  type: flag
1210
1351
  - name: edit
1211
1352
  description: Edit an existing lifecycle rule by its id. Only specified fields are changed
1353
+ helpText: Edit a lifecycle rule by its id
1212
1354
  alias: e
1213
1355
  examples:
1214
1356
  - "tigris buckets lifecycle edit my-bucket abc123 --days 60"
@@ -1253,7 +1395,9 @@ commands:
1253
1395
  type: flag
1254
1396
  # set-notifications
1255
1397
  - name: set-notifications
1398
+ group: Configuration
1256
1399
  description: Configure object event notifications on a bucket. Sends webhook requests to a URL when objects are created, updated, or deleted
1400
+ helpText: Configure object event webhooks on a bucket
1257
1401
  examples:
1258
1402
  - "tigris buckets set-notifications my-bucket --url https://example.com/webhook"
1259
1403
  - "tigris buckets set-notifications my-bucket --url https://example.com/webhook --token secret123"
@@ -1297,7 +1441,9 @@ commands:
1297
1441
  type: flag
1298
1442
  # set-cors
1299
1443
  - name: set-cors
1444
+ group: Configuration
1300
1445
  description: Configure CORS rules on a bucket. Each invocation adds a rule unless --override or --reset is used
1446
+ helpText: Configure CORS rules on a bucket
1301
1447
  examples:
1302
1448
  - "tigris buckets set-cors my-bucket --origins '*' --methods GET,HEAD"
1303
1449
  - "tigris buckets set-cors my-bucket --origins https://example.com --methods GET,POST --headers Content-Type,Authorization --max-age 3600"
@@ -1335,7 +1481,9 @@ commands:
1335
1481
 
1336
1482
  # share
1337
1483
  - name: share
1484
+ group: Configuration
1338
1485
  description: Share a bucket with your whole organization, specific teams, or specific users. Existing shares are kept unless --override or --reset is used
1486
+ helpText: Share a bucket with your organization, teams, or users
1339
1487
  examples:
1340
1488
  - "tigris buckets share my-bucket --organization --role ReadOnly"
1341
1489
  - "tigris buckets share my-bucket --team tmid_MQQUhV --role Editor"
@@ -1357,18 +1505,22 @@ commands:
1357
1505
  - name: organization
1358
1506
  alias: org
1359
1507
  description: Give access to everyone in your organization. Takes exactly one --role and cannot be combined with --team or --user
1508
+ helpText: Share with your whole organization. Takes one --role; excludes --team/--user
1360
1509
  type: flag
1361
1510
  - name: team
1362
1511
  alias: t
1363
1512
  description: Team ID to share with (can specify multiple, comma-separated). Each team is paired positionally with a --role value
1513
+ helpText: Team ID(s), comma-separated. Each pairs positionally with a --role
1364
1514
  multiple: true
1365
1515
  - name: user
1366
1516
  alias: u
1367
1517
  description: User ID to share with (can specify multiple, comma-separated). Each user is paired positionally with a --role value
1518
+ helpText: User ID(s), comma-separated. Each pairs positionally with a --role
1368
1519
  multiple: true
1369
1520
  - name: role
1370
1521
  alias: r
1371
1522
  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
1523
+ helpText: Role(s) to grant, comma-separated. One role applies to every target
1372
1524
  multiple: true
1373
1525
  options:
1374
1526
  - ReadOnly
@@ -1393,7 +1545,9 @@ commands:
1393
1545
  # Manage snapshots
1394
1546
  #########################
1395
1547
  - name: snapshots
1548
+ group: Manage resources
1396
1549
  description: List, take, and delete snapshots. A snapshot is a point-in-time, read-only copy of a bucket's state
1550
+ helpText: List, take, and delete bucket snapshots
1397
1551
  alias: s
1398
1552
  examples:
1399
1553
  - "tigris snapshots list my-bucket"
@@ -1403,6 +1557,7 @@ commands:
1403
1557
  # list
1404
1558
  - name: list
1405
1559
  description: List all snapshots for the given bucket, ordered by creation time
1560
+ helpText: List a bucket's snapshots, ordered by creation time
1406
1561
  alias: l
1407
1562
  examples:
1408
1563
  - "tigris snapshots list my-bucket"
@@ -1431,6 +1586,7 @@ commands:
1431
1586
  # take
1432
1587
  - name: take
1433
1588
  description: Take a new snapshot of the bucket's current state. Optionally provide a name for the snapshot
1589
+ helpText: Take a snapshot of a bucket's current state
1434
1590
  alias: t
1435
1591
  examples:
1436
1592
  - "tigris snapshots take my-bucket"
@@ -1455,6 +1611,7 @@ commands:
1455
1611
  # delete
1456
1612
  - name: delete
1457
1613
  description: Delete one or more snapshots of a bucket by version. Deletion is permanent; forks already created from a snapshot are unaffected
1614
+ helpText: Permanently delete one or more snapshots
1458
1615
  alias: d
1459
1616
  examples:
1460
1617
  - "tigris snapshots delete my-bucket 1765889000501544464 --yes"
@@ -1467,6 +1624,7 @@ commands:
1467
1624
  - command: 'tigris snapshots list {{name}}'
1468
1625
  description: 'List remaining snapshots'
1469
1626
  arguments:
1627
+ - *yes_argument
1470
1628
  - name: name
1471
1629
  description: Name of the bucket
1472
1630
  type: positional
@@ -1475,6 +1633,7 @@ commands:
1475
1633
  - my-bucket
1476
1634
  - name: version
1477
1635
  description: Snapshot version, or comma separated list of versions. Find versions with "tigris snapshots list"
1636
+ helpText: Snapshot version(s), comma-separated. See "tigris snapshots list"
1478
1637
  type: positional
1479
1638
  required: true
1480
1639
  multiple: true
@@ -1490,7 +1649,10 @@ commands:
1490
1649
  # Manage objects
1491
1650
  #########################
1492
1651
  - name: objects
1652
+ group: Manage resources
1653
+ groups: [Basics, Versions & recovery, Archive]
1493
1654
  description: Low-level object operations for listing, downloading, uploading, and deleting individual objects in a bucket
1655
+ helpText: List, download, upload, and delete objects
1494
1656
  alias: o
1495
1657
  examples:
1496
1658
  - "tigris objects list my-bucket"
@@ -1501,7 +1663,9 @@ commands:
1501
1663
  commands:
1502
1664
  # list
1503
1665
  - name: list
1666
+ group: Basics
1504
1667
  description: List objects in a bucket, optionally filtered by a key prefix
1668
+ helpText: List objects in a bucket, optionally by key prefix
1505
1669
  alias: l
1506
1670
  examples:
1507
1671
  - "tigris objects list my-bucket"
@@ -1533,6 +1697,7 @@ commands:
1533
1697
  default: table
1534
1698
  - name: snapshot-version
1535
1699
  description: Read from a specific bucket snapshot. Accepts a snapshot version string or any UNIX nanosecond-precision timestamp (e.g. 1765889000501544464)
1700
+ helpText: Read from a bucket snapshot (version or UNIX nanosecond timestamp)
1536
1701
  alias: snapshot
1537
1702
  - name: limit
1538
1703
  description: Maximum number of items to return per page
@@ -1541,13 +1706,17 @@ commands:
1541
1706
  alias: pt
1542
1707
  - name: source
1543
1708
  description: List objects from a specific storage source on buckets with shadow migration enabled
1709
+ helpText: Storage source to list from on shadow-migration buckets
1544
1710
  options: [tigris, shadow]
1545
1711
  - name: deleted
1546
1712
  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
1713
+ helpText: List soft-deleted objects instead of live ones
1547
1714
  type: flag
1548
1715
  # list-versions
1549
1716
  - name: list-versions
1717
+ group: Versions & recovery
1550
1718
  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
1719
+ helpText: List object versions and delete markers
1551
1720
  alias: lv
1552
1721
  examples:
1553
1722
  - "tigris objects list-versions my-bucket"
@@ -1573,6 +1742,7 @@ commands:
1573
1742
  alias: p
1574
1743
  - name: delimiter
1575
1744
  description: Group keys sharing a common prefix up to the delimiter (e.g. "/" for folder-style grouping)
1745
+ helpText: Group keys by common prefix up to the delimiter (e.g. "/")
1576
1746
  alias: d
1577
1747
  - name: format
1578
1748
  description: Output format
@@ -1582,14 +1752,19 @@ commands:
1582
1752
  description: Maximum number of items to return per page
1583
1753
  - name: key-marker
1584
1754
  description: Pagination marker — the key to start listing from (from a prior nextKeyMarker)
1755
+ helpText: "Pagination marker: key to start from (a prior nextKeyMarker)"
1585
1756
  - name: version-id-marker
1586
1757
  description: Pagination marker — the version id to start listing from (from a prior nextVersionIdMarker)
1758
+ helpText: "Pagination marker: version id to start from (a prior nextVersionIdMarker)"
1587
1759
  - name: deleted
1588
1760
  description: List the recoverable versions of soft-deleted objects. Use the version id with "tigris objects restore-deleted" or "tigris objects purge"
1761
+ helpText: List the recoverable versions of soft-deleted objects
1589
1762
  type: flag
1590
1763
  # get
1591
1764
  - name: get
1765
+ group: Basics
1592
1766
  description: Download an object by key. Prints to stdout by default, or saves to a file with --output
1767
+ helpText: Download an object to stdout or a file
1593
1768
  alias: g
1594
1769
  examples:
1595
1770
  - "tigris objects get my-bucket config.json"
@@ -1617,16 +1792,21 @@ commands:
1617
1792
  alias: o
1618
1793
  - name: mode
1619
1794
  description: 'Response mode: "string" loads into memory, "stream" writes in chunks (auto-detected from extension if not specified)'
1795
+ helpText: "Response mode: string (in memory) or stream (chunked). Auto-detected"
1620
1796
  alias: m
1621
1797
  options: [string, stream]
1622
1798
  - name: snapshot-version
1623
1799
  description: Read from a specific bucket snapshot. Accepts a snapshot version string or any UNIX nanosecond-precision timestamp (e.g. 1765889000501544464)
1800
+ helpText: Read from a bucket snapshot (version or UNIX nanosecond timestamp)
1624
1801
  alias: snapshot
1625
1802
  - name: version-id
1626
1803
  description: Object version id to download (requires bucket versioning). Omit to download the latest version
1804
+ helpText: Object version id to download. Omit for the latest version
1627
1805
  # put
1628
1806
  - name: put
1807
+ group: Basics
1629
1808
  description: Upload a local file — or data piped via stdin — as an object. Content-type is auto-detected from the file extension unless overridden
1809
+ helpText: Upload a local file or stdin as an object
1630
1810
  alias: p
1631
1811
  examples:
1632
1812
  - "tigris objects put my-bucket report.pdf ./report.pdf"
@@ -1657,6 +1837,7 @@ commands:
1657
1837
  - my-file.txt
1658
1838
  - name: file
1659
1839
  description: Path to the local file to upload. Omit to read the object data from stdin (piped input)
1840
+ helpText: Local file to upload. Omit to read from stdin
1660
1841
  type: positional
1661
1842
  examples:
1662
1843
  - ./my-file.txt
@@ -1670,13 +1851,16 @@ commands:
1670
1851
  alias: t
1671
1852
  - name: cache-control
1672
1853
  description: Cache-Control header stored with the object and returned on every read (e.g. "public, max-age=31536000, immutable")
1854
+ helpText: Cache-Control header stored with the object and returned on reads
1673
1855
  - name: format
1674
1856
  description: Output format
1675
1857
  options: [json, table, xml]
1676
1858
  default: table
1677
1859
  # delete
1678
1860
  - name: delete
1861
+ group: Basics
1679
1862
  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
1863
+ helpText: Delete one or more objects by key
1680
1864
  alias: d
1681
1865
  examples:
1682
1866
  - "tigris objects delete my-bucket old-file.txt --yes"
@@ -1692,6 +1876,7 @@ commands:
1692
1876
  - command: 'tigris ls {{bucket}}'
1693
1877
  description: 'List remaining objects in the bucket'
1694
1878
  arguments:
1879
+ - *yes_argument
1695
1880
  - name: bucket
1696
1881
  description: Name of the bucket, or a full path (t3://bucket/key)
1697
1882
  type: positional
@@ -1701,21 +1886,26 @@ commands:
1701
1886
  - t3://my-bucket/old-file.txt
1702
1887
  - name: key
1703
1888
  description: Key of the object (comma separated for multiple, omit if bucket contains the full path)
1889
+ helpText: Object key(s), comma-separated. Omit if the bucket arg has the full path
1704
1890
  type: positional
1705
1891
  multiple: true
1706
1892
  examples:
1707
1893
  - my-file.txt
1708
1894
  - name: version-id
1709
1895
  description: Hard-delete a specific object version (requires bucket versioning). Targets a single key. To destroy a soft-deleted version, use "tigris objects purge"
1896
+ helpText: Hard-delete a specific object version (single key only)
1710
1897
  - name: all-versions
1711
1898
  description: Hard-delete every version and delete marker for the given key(s). Mutually exclusive with --version-id
1899
+ helpText: Hard-delete every version and delete marker. Excludes --version-id
1712
1900
  type: flag
1713
1901
  - name: force
1714
1902
  type: flag
1715
1903
  description: Skip confirmation prompts (alias for --yes)
1716
1904
  # set (deprecated)
1717
1905
  - name: set
1906
+ group: Basics
1718
1907
  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
1908
+ helpText: (Deprecated) Update settings on an existing object
1719
1909
  alias: s
1720
1910
  deprecated: true
1721
1911
  examples:
@@ -1745,7 +1935,9 @@ commands:
1745
1935
  alias: n
1746
1936
  # set-access
1747
1937
  - name: set-access
1938
+ group: Basics
1748
1939
  description: Set the access level (public or private) on an existing object
1940
+ helpText: Set an object's access level (public or private)
1749
1941
  alias: sa
1750
1942
  examples:
1751
1943
  - "tigris objects set-access my-bucket my-file.txt public"
@@ -1764,6 +1956,7 @@ commands:
1764
1956
  type: positional
1765
1957
  - name: access
1766
1958
  description: Access level (public or private)
1959
+ helpText: Access level
1767
1960
  type: positional
1768
1961
  options: *access_options
1769
1962
  - name: format
@@ -1772,7 +1965,9 @@ commands:
1772
1965
  default: table
1773
1966
  # info
1774
1967
  - name: info
1968
+ group: Basics
1775
1969
  description: Show metadata for an object (content type, size, modified date)
1970
+ helpText: Show an object's content type, size, and modified date
1776
1971
  alias: i
1777
1972
  examples:
1778
1973
  - "tigris objects info my-bucket report.pdf"
@@ -1802,7 +1997,9 @@ commands:
1802
1997
  description: Object version id (requires bucket versioning). Omit to read the latest version
1803
1998
  # restore
1804
1999
  - name: restore
2000
+ group: Archive
1805
2001
  description: Restore an archived object (e.g. one in the GLACIER tier) into an actively-readable copy for a number of days
2002
+ helpText: Restore an archived object for a number of days
1806
2003
  alias: rs
1807
2004
  examples:
1808
2005
  - "tigris objects restore my-bucket archived.bin"
@@ -1823,12 +2020,15 @@ commands:
1823
2020
  description: Key of the object (omit if bucket contains the full path)
1824
2021
  - name: days
1825
2022
  description: How many days the restored copy stays available before reverting to its archived tier
2023
+ helpText: Days the restored copy stays available before re-archiving
1826
2024
  alias: d
1827
2025
  default: 1
1828
2026
  - name: version-id
1829
2027
  description: Restore a specific object version (requires bucket versioning). Omit to restore the current version
2028
+ helpText: Object version to restore. Omit for the current version
1830
2029
  - name: snapshot-version
1831
2030
  description: Restore the object as of a specific bucket snapshot. Accepts a snapshot version string or any UNIX nanosecond-precision timestamp (e.g. 1765889000501544464)
2031
+ helpText: Restore as of a bucket snapshot (version or UNIX nanosecond timestamp)
1832
2032
  alias: snapshot
1833
2033
  - name: format
1834
2034
  description: Output format
@@ -1836,7 +2036,9 @@ commands:
1836
2036
  default: table
1837
2037
  # restore-info
1838
2038
  - name: restore-info
2039
+ group: Archive
1839
2040
  description: Show the restore state of an archived object (archived, in-progress, or restored)
2041
+ helpText: Show the restore state of an archived object
1840
2042
  alias: ri
1841
2043
  examples:
1842
2044
  - "tigris objects restore-info my-bucket archived.bin"
@@ -1857,8 +2059,10 @@ commands:
1857
2059
  description: Key of the object (omit if bucket contains the full path)
1858
2060
  - name: version-id
1859
2061
  description: Inspect a specific object version (requires bucket versioning). Omit to read the current version
2062
+ helpText: Object version to inspect. Omit for the current version
1860
2063
  - name: snapshot-version
1861
2064
  description: Inspect the object as of a specific bucket snapshot. Accepts a snapshot version string or any UNIX nanosecond-precision timestamp (e.g. 1765889000501544464)
2065
+ helpText: Inspect as of a bucket snapshot (version or UNIX nanosecond timestamp)
1862
2066
  alias: snapshot
1863
2067
  - name: format
1864
2068
  description: Output format
@@ -1866,7 +2070,9 @@ commands:
1866
2070
  default: table
1867
2071
  # restore-deleted
1868
2072
  - name: restore-deleted
2073
+ group: Versions & recovery
1869
2074
  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"
2075
+ helpText: Restore a soft-deleted object
1870
2076
  alias: rd
1871
2077
  examples:
1872
2078
  - "tigris objects restore-deleted my-bucket report.pdf --version-id 1787749774802410496"
@@ -1894,13 +2100,16 @@ commands:
1894
2100
  - name: version-id
1895
2101
  required: true
1896
2102
  description: The soft-deleted version to bring back, from "tigris objects list-versions --deleted"
2103
+ helpText: Soft-deleted version to restore (see "objects list-versions --deleted")
1897
2104
  - name: format
1898
2105
  description: Output format
1899
2106
  options: [json, table, xml]
1900
2107
  default: table
1901
2108
  # purge
1902
2109
  - name: purge
2110
+ group: Versions & recovery
1903
2111
  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"
2112
+ helpText: Permanently destroy a soft-deleted object version
1904
2113
  alias: pg
1905
2114
  examples:
1906
2115
  - "tigris objects purge my-bucket report.pdf --version-id 1787749774802410496 --yes"
@@ -1910,6 +2119,7 @@ commands:
1910
2119
  onSuccess: "Purged version '{{versionId}}' of '{{key}}'"
1911
2120
  onFailure: 'Failed to purge deleted object'
1912
2121
  arguments:
2122
+ - *yes_argument
1913
2123
  - name: bucket
1914
2124
  type: positional
1915
2125
  required: true
@@ -1925,6 +2135,7 @@ commands:
1925
2135
  - name: version-id
1926
2136
  required: true
1927
2137
  description: The soft-deleted version to destroy, from "tigris objects list-versions --deleted"
2138
+ helpText: Soft-deleted version to destroy (see "objects list-versions --deleted")
1928
2139
  - name: force
1929
2140
  type: flag
1930
2141
  description: Skip confirmation prompts (alias for --yes)
@@ -1937,11 +2148,13 @@ commands:
1937
2148
  # Manage access keys
1938
2149
  #########################
1939
2150
  - name: access-keys
2151
+ group: Manage resources
1940
2152
  description: Create, list, inspect, delete, and assign roles to access keys. Access keys are credentials used for programmatic API access
2153
+ helpText: Manage access keys and their bucket roles
1941
2154
  alias: keys
1942
2155
  examples:
1943
2156
  - "tigris access-keys list"
1944
- - "tigris access-keys create my-ci-key"
2157
+ - "tigris access-keys create my-app --bucket my-app-bucket --role Editor --env"
1945
2158
  - "tigris access-keys assign tid_AaBb --bucket my-bucket --role Editor"
1946
2159
  commands:
1947
2160
  - name: list
@@ -1965,10 +2178,13 @@ commands:
1965
2178
  description: Pagination token from a previous request to fetch the next page
1966
2179
  alias: pt
1967
2180
  - name: create
1968
- description: Create a new access key with the given name. Returns the key ID and secret (shown only once)
2181
+ 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)
2182
+ helpText: Create a new access key and export its credentials
1969
2183
  alias: c
1970
2184
  examples:
1971
2185
  - "tigris access-keys create my-ci-key"
2186
+ - "tigris access-keys create my-app --bucket my-app-bucket --role Editor --env"
2187
+ - 'eval "$(tigris access-keys create dev --bucket my-app-bucket --role Editor --export)"'
1972
2188
  messages:
1973
2189
  onStart: 'Creating access key...'
1974
2190
  onSuccess: 'Access key created'
@@ -1983,8 +2199,24 @@ commands:
1983
2199
  required: true
1984
2200
  examples:
1985
2201
  - my-key
2202
+ - *key_bucket_argument
2203
+ - *key_role_argument
2204
+ - *key_admin_argument
2205
+ - name: env
2206
+ description: Write the credentials to a dotenv file, merging into it when it already exists. Defaults to ./.env. The secret is then not printed
2207
+ helpText: Write the credentials to a dotenv file (default ./.env)
2208
+ - name: export
2209
+ type: flag
2210
+ description: Print the credentials as shell "export" lines and nothing else on stdout, for eval "$(tigris access-keys create <name> --export)"
2211
+ helpText: Print shell "export" lines for eval "$(...)"
2212
+ - name: for
2213
+ 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
2214
+ helpText: SDK the variables are named for (with --env or --export)
2215
+ options: [tigris, aws]
2216
+ default: tigris
1986
2217
  - name: delete
1987
2218
  description: Permanently delete an access key by its ID. This revokes all access immediately
2219
+ helpText: Permanently delete an access key
1988
2220
  alias: d
1989
2221
  examples:
1990
2222
  - "tigris access-keys delete tid_AaBbCcDdEeFf --yes"
@@ -1993,6 +2225,7 @@ commands:
1993
2225
  onSuccess: 'Access key deleted'
1994
2226
  onFailure: 'Failed to delete access key'
1995
2227
  arguments:
2228
+ - *yes_argument
1996
2229
  - name: id
1997
2230
  description: Access key ID
1998
2231
  type: positional
@@ -2004,6 +2237,7 @@ commands:
2004
2237
  description: Skip confirmation prompts (alias for --yes)
2005
2238
  - name: get
2006
2239
  description: Show details for an access key including its name, creation date, and assigned bucket roles
2240
+ helpText: Show an access key's details and bucket roles
2007
2241
  alias: g
2008
2242
  examples:
2009
2243
  - "tigris access-keys get tid_AaBbCcDdEeFf"
@@ -2020,6 +2254,7 @@ commands:
2020
2254
  - tid_AaBbCcDdEeFf
2021
2255
  - name: assign
2022
2256
  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
2257
+ helpText: Assign per-bucket roles to an access key
2023
2258
  alias: a
2024
2259
  examples:
2025
2260
  - "tigris access-keys assign tid_AaBb --bucket my-bucket --role Editor"
@@ -2040,26 +2275,15 @@ commands:
2040
2275
  required: true
2041
2276
  examples:
2042
2277
  - 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
2278
+ - *key_bucket_argument
2279
+ - *key_role_argument
2280
+ - *key_admin_argument
2058
2281
  - name: revoke-roles
2059
2282
  description: Revoke all bucket roles from the access key
2060
2283
  type: flag
2061
2284
  - name: rotate
2062
2285
  description: Rotate an access key's secret. The current secret is immediately invalidated and a new one is returned (shown only once)
2286
+ helpText: Rotate an access key's secret
2063
2287
  alias: r
2064
2288
  examples:
2065
2289
  - "tigris access-keys rotate tid_AaBbCcDdEeFf --yes"
@@ -2071,6 +2295,7 @@ commands:
2071
2295
  - command: 'tigris access-keys get {{id}}'
2072
2296
  description: 'Verify the rotated access key'
2073
2297
  arguments:
2298
+ - *yes_argument
2074
2299
  - name: id
2075
2300
  description: Access key ID
2076
2301
  type: positional
@@ -2082,6 +2307,7 @@ commands:
2082
2307
  description: Skip confirmation prompts (alias for --yes)
2083
2308
  - name: attach-policy
2084
2309
  description: Attach an IAM policy to an access key. If no policy ARN is provided, shows interactive selection of available policies
2310
+ helpText: Attach an IAM policy to an access key
2085
2311
  alias: ap
2086
2312
  examples:
2087
2313
  - "tigris access-keys attach-policy tid_AaBb --policy-arn arn:aws:iam::org_id:policy/my-policy"
@@ -2103,6 +2329,7 @@ commands:
2103
2329
  - arn:aws:iam::org_id:policy/my-policy
2104
2330
  - name: detach-policy
2105
2331
  description: Detach an IAM policy from an access key. If no policy ARN is provided, shows interactive selection of attached policies
2332
+ helpText: Detach an IAM policy from an access key
2106
2333
  alias: dp
2107
2334
  examples:
2108
2335
  - "tigris access-keys detach-policy tid_AaBb --policy-arn arn:aws:iam::org_id:policy/my-policy --yes"
@@ -2112,6 +2339,7 @@ commands:
2112
2339
  onSuccess: 'Policy detached'
2113
2340
  onFailure: 'Failed to detach policy'
2114
2341
  arguments:
2342
+ - *yes_argument
2115
2343
  - name: id
2116
2344
  description: Access key ID
2117
2345
  type: positional
@@ -2156,7 +2384,9 @@ commands:
2156
2384
  # IAM - Identity and Access Management
2157
2385
  #########################
2158
2386
  - name: iam
2387
+ group: Manage resources
2159
2388
  description: Identity and Access Management - manage policies, users, and permissions
2389
+ helpText: Manage IAM policies, users, and teams
2160
2390
  examples:
2161
2391
  - "tigris iam policies list"
2162
2392
  - "tigris iam policies create my-policy --document policy.json"
@@ -2165,6 +2395,7 @@ commands:
2165
2395
  commands:
2166
2396
  - name: policies
2167
2397
  description: Manage IAM policies. Policies define permissions for access keys
2398
+ helpText: Manage IAM policies
2168
2399
  alias: p
2169
2400
  examples:
2170
2401
  - "tigris iam policies list"
@@ -2192,6 +2423,7 @@ commands:
2192
2423
  alias: pt
2193
2424
  - name: get
2194
2425
  description: Show details for a policy including its document and attached users. If no ARN provided, shows interactive selection
2426
+ helpText: Show a policy's document and attached users
2195
2427
  alias: g
2196
2428
  examples:
2197
2429
  - "tigris iam policies get"
@@ -2214,6 +2446,7 @@ commands:
2214
2446
  default: table
2215
2447
  - name: create
2216
2448
  description: Create a new policy with the given name and policy document. Document can be provided via file, inline JSON, or stdin
2449
+ helpText: Create a policy from a file, inline JSON, or stdin
2217
2450
  alias: c
2218
2451
  examples:
2219
2452
  - "tigris iam policies create my-policy --document policy.json"
@@ -2232,12 +2465,14 @@ commands:
2232
2465
  - my-policy
2233
2466
  - name: document
2234
2467
  description: Policy document (JSON file path or inline JSON). If omitted, reads from stdin
2468
+ helpText: Policy document (JSON file or inline JSON). Omit to read stdin
2235
2469
  alias: d
2236
2470
  required: false
2237
2471
  - name: description
2238
2472
  description: Policy description
2239
2473
  - name: edit
2240
2474
  description: Update an existing policy's document. Document can be provided via file, inline JSON, or stdin. If no ARN provided, shows interactive selection
2475
+ helpText: Update an existing policy's document
2241
2476
  alias: e
2242
2477
  examples:
2243
2478
  - "tigris iam policies edit --document policy.json"
@@ -2257,6 +2492,7 @@ commands:
2257
2492
  - arn:aws:iam::org_id:policy/my-policy
2258
2493
  - name: document
2259
2494
  description: New policy document (JSON file path or inline JSON). If omitted, reads from stdin
2495
+ helpText: New policy document (JSON file or inline JSON). Omit to read stdin
2260
2496
  alias: d
2261
2497
  required: false
2262
2498
  - name: description
@@ -2264,6 +2500,7 @@ commands:
2264
2500
  required: false
2265
2501
  - name: delete
2266
2502
  description: Delete a policy. If no ARN provided, shows interactive selection
2503
+ helpText: Delete a policy
2267
2504
  alias: d
2268
2505
  examples:
2269
2506
  - "tigris iam policies delete"
@@ -2274,6 +2511,7 @@ commands:
2274
2511
  onFailure: 'Failed to delete policy'
2275
2512
  onEmpty: 'No policies found'
2276
2513
  arguments:
2514
+ - *yes_argument
2277
2515
  - name: resource
2278
2516
  description: Policy ARN. If omitted, shows interactive selection
2279
2517
  type: positional
@@ -2285,6 +2523,7 @@ commands:
2285
2523
  description: Skip confirmation prompts (alias for --yes)
2286
2524
  - name: link-key
2287
2525
  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
2526
+ helpText: Link an access key to a policy
2288
2527
  alias: lnk
2289
2528
  examples:
2290
2529
  - "tigris iam policies link-key arn:aws:iam::org_id:policy/my-policy --id tid_AaBb"
@@ -2307,6 +2546,7 @@ commands:
2307
2546
  - tid_AaBbCcDdEeFf
2308
2547
  - name: unlink-key
2309
2548
  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
2549
+ helpText: Unlink an access key from a policy
2310
2550
  alias: ulnk
2311
2551
  examples:
2312
2552
  - "tigris iam policies unlink-key arn:aws:iam::org_id:policy/my-policy --id tid_AaBb --yes"
@@ -2317,6 +2557,7 @@ commands:
2317
2557
  onFailure: 'Failed to unlink access key'
2318
2558
  onEmpty: 'No policies found'
2319
2559
  arguments:
2560
+ - *yes_argument
2320
2561
  - name: resource
2321
2562
  description: Policy ARN. If omitted, shows interactive selection
2322
2563
  type: positional
@@ -2332,6 +2573,7 @@ commands:
2332
2573
  description: Skip confirmation prompts (alias for --yes)
2333
2574
  - name: list-keys
2334
2575
  description: List all access keys attached to a policy. If no policy ARN is provided, shows interactive selection
2576
+ helpText: List the access keys attached to a policy
2335
2577
  alias: lk
2336
2578
  examples:
2337
2579
  - "tigris iam policies list-keys arn:aws:iam::org_id:policy/my-policy"
@@ -2404,6 +2646,7 @@ commands:
2404
2646
  default: member
2405
2647
  - name: revoke-invitation
2406
2648
  description: Revoke pending invitations. If no invitation ID provided, shows interactive selection
2649
+ helpText: Revoke pending invitations
2407
2650
  alias: ri
2408
2651
  examples:
2409
2652
  - "tigris iam users revoke-invitation"
@@ -2415,8 +2658,10 @@ commands:
2415
2658
  onFailure: 'Failed to revoke invitation'
2416
2659
  onEmpty: 'No pending invitations found'
2417
2660
  arguments:
2661
+ - *yes_argument
2418
2662
  - name: resource
2419
2663
  description: Invitation ID(s) (comma-separated for multiple). If omitted, shows interactive selection
2664
+ helpText: Invitation ID(s), comma-separated. Omit to select interactively
2420
2665
  type: positional
2421
2666
  required: false
2422
2667
  multiple: true
@@ -2425,6 +2670,7 @@ commands:
2425
2670
  description: Skip confirmation prompts (alias for --yes)
2426
2671
  - name: update-role
2427
2672
  description: Update user roles in the organization. If no user ID provided, shows interactive selection
2673
+ helpText: Update user roles in the organization
2428
2674
  alias: ur
2429
2675
  examples:
2430
2676
  - "tigris iam users update-role --role admin"
@@ -2439,17 +2685,20 @@ commands:
2439
2685
  arguments:
2440
2686
  - name: resource
2441
2687
  description: User ID(s) (comma-separated for multiple). If omitted, shows interactive selection
2688
+ helpText: User ID(s), comma-separated. Omit to select interactively
2442
2689
  type: positional
2443
2690
  required: false
2444
2691
  multiple: true
2445
2692
  - name: role
2446
2693
  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
2694
+ helpText: Role(s), comma-separated. One role applies to all users
2447
2695
  alias: r
2448
2696
  required: true
2449
2697
  options: [admin, member]
2450
2698
  multiple: true
2451
2699
  - name: remove
2452
2700
  description: Remove users from the organization. If no user ID provided, shows interactive selection
2701
+ helpText: Remove users from the organization
2453
2702
  alias: rm
2454
2703
  examples:
2455
2704
  - "tigris iam users remove"
@@ -2461,8 +2710,10 @@ commands:
2461
2710
  onFailure: 'Failed to remove user'
2462
2711
  onEmpty: 'No users found in this organization'
2463
2712
  arguments:
2713
+ - *yes_argument
2464
2714
  - name: resource
2465
2715
  description: User ID(s) (comma-separated for multiple). If omitted, shows interactive selection
2716
+ helpText: User ID(s), comma-separated. Omit to select interactively
2466
2717
  type: positional
2467
2718
  required: false
2468
2719
  multiple: true
@@ -2520,6 +2771,7 @@ commands:
2520
2771
  multiple: true
2521
2772
  - name: edit
2522
2773
  description: Update a team's name, description, or members. Members are replaced with the provided list
2774
+ helpText: Update a team's name, description, or members
2523
2775
  alias: e
2524
2776
  examples:
2525
2777
  - "tigris iam teams edit team_id --name platform"
@@ -2542,5 +2794,6 @@ commands:
2542
2794
  alias: d
2543
2795
  - name: members
2544
2796
  description: Replace the team's members with these email address(es) (comma-separated for multiple)
2797
+ helpText: Member email(s), comma-separated. Replaces the current members
2545
2798
  alias: m
2546
2799
  multiple: true