@tigrisdata/cli 3.17.2 → 3.18.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 (122) hide show
  1. package/README.md +114 -20
  2. package/dist/auth/iam.js +1 -1
  3. package/dist/auth/provider.js +1 -1
  4. package/dist/browser/index.js +187 -162
  5. package/dist/{chunk-4BWK33XD.js → chunk-33VTJA5G.js} +1 -1
  6. package/dist/{chunk-QJMLIBCG.js → chunk-55YC7L3R.js} +1 -1
  7. package/dist/{chunk-JQRHEFN2.js → chunk-5R42YPIF.js} +1 -1
  8. package/dist/{chunk-QJKKFI5K.js → chunk-BQPKRG5X.js} +1 -1
  9. package/dist/{chunk-5FFSAQBH.js → chunk-E52D2O5C.js} +1 -1
  10. package/dist/{chunk-H4VWRKBZ.js → chunk-GREORRSJ.js} +1 -1
  11. package/dist/{chunk-XCHHTO54.js → chunk-NEHPRANM.js} +1 -1
  12. package/dist/{chunk-A6IZCL2R.js → chunk-OK2INJKO.js} +1 -1
  13. package/dist/{chunk-56W4QIZP.js → chunk-PYPHHAPF.js} +1 -1
  14. package/dist/{chunk-6R467XCM.js → chunk-Q24ZEHJN.js} +1 -1
  15. package/dist/{chunk-VI5JXLP7.js → chunk-QOOQVR7J.js} +1 -1
  16. package/dist/chunk-SFXAZO6M.js +1 -0
  17. package/dist/{chunk-APVIWSSE.js → chunk-STUJSAPH.js} +1 -1
  18. package/dist/{chunk-YRVVZ64M.js → chunk-TBJQJJ45.js} +1 -1
  19. package/dist/{chunk-U63FQLE2.js → chunk-TBX42XAN.js} +1 -1
  20. package/dist/cli-core.js +3 -3
  21. package/dist/cli.js +1 -1
  22. package/dist/index.js +1 -1
  23. package/dist/lib/access-keys/assign.js +1 -1
  24. package/dist/lib/access-keys/attach-policy.js +1 -1
  25. package/dist/lib/access-keys/create.js +1 -1
  26. package/dist/lib/access-keys/default-permissions.js +1 -1
  27. package/dist/lib/access-keys/delete.js +1 -1
  28. package/dist/lib/access-keys/detach-policy.js +1 -1
  29. package/dist/lib/access-keys/get.js +1 -1
  30. package/dist/lib/access-keys/list-policies.js +1 -1
  31. package/dist/lib/access-keys/list.js +1 -1
  32. package/dist/lib/access-keys/roles.js +1 -1
  33. package/dist/lib/access-keys/rotate.js +1 -1
  34. package/dist/lib/access-keys/set.js +1 -1
  35. package/dist/lib/buckets/create.js +1 -1
  36. package/dist/lib/buckets/delete.js +1 -1
  37. package/dist/lib/buckets/disable-snapshots.js +1 -1
  38. package/dist/lib/buckets/enable-snapshots.js +1 -1
  39. package/dist/lib/buckets/get.js +1 -1
  40. package/dist/lib/buckets/lifecycle/create.js +1 -1
  41. package/dist/lib/buckets/lifecycle/edit.js +1 -1
  42. package/dist/lib/buckets/lifecycle/list.js +1 -1
  43. package/dist/lib/buckets/lifecycle/shared.js +1 -1
  44. package/dist/lib/buckets/list.js +1 -1
  45. package/dist/lib/buckets/merge.js +1 -1
  46. package/dist/lib/buckets/migrate.js +1 -1
  47. package/dist/lib/buckets/purge.js +1 -1
  48. package/dist/lib/buckets/rebase.js +1 -1
  49. package/dist/lib/buckets/restore.js +1 -1
  50. package/dist/lib/buckets/set-cors.js +1 -1
  51. package/dist/lib/buckets/set-locations.js +1 -1
  52. package/dist/lib/buckets/set-migration.js +1 -1
  53. package/dist/lib/buckets/set-notifications.js +1 -1
  54. package/dist/lib/buckets/set.js +1 -1
  55. package/dist/lib/buckets/share.js +1 -1
  56. package/dist/lib/bundle.js +1 -1
  57. package/dist/lib/configure/index.js +1 -1
  58. package/dist/lib/cp.js +1 -1
  59. package/dist/lib/credentials/test.js +1 -1
  60. package/dist/lib/iam/policies/create.js +1 -1
  61. package/dist/lib/iam/policies/delete.js +1 -1
  62. package/dist/lib/iam/policies/edit.js +1 -1
  63. package/dist/lib/iam/policies/get.js +1 -1
  64. package/dist/lib/iam/policies/link-key.js +1 -1
  65. package/dist/lib/iam/policies/list-keys.js +1 -1
  66. package/dist/lib/iam/policies/list.js +1 -1
  67. package/dist/lib/iam/policies/select-policy.js +1 -1
  68. package/dist/lib/iam/policies/unlink-key.js +1 -1
  69. package/dist/lib/iam/teams/create.js +1 -1
  70. package/dist/lib/iam/teams/edit.js +1 -1
  71. package/dist/lib/iam/teams/list.js +1 -1
  72. package/dist/lib/iam/teams/shared.js +1 -1
  73. package/dist/lib/iam/users/invite.js +1 -1
  74. package/dist/lib/iam/users/list.js +1 -1
  75. package/dist/lib/iam/users/remove.js +1 -1
  76. package/dist/lib/iam/users/revoke-invitation.js +1 -1
  77. package/dist/lib/iam/users/update-role.js +1 -1
  78. package/dist/lib/login/credentials.js +1 -1
  79. package/dist/lib/login/oauth.js +1 -1
  80. package/dist/lib/login/select.js +1 -1
  81. package/dist/lib/logout.js +1 -1
  82. package/dist/lib/ls.js +1 -1
  83. package/dist/lib/mk.js +1 -1
  84. package/dist/lib/mv.js +1 -1
  85. package/dist/lib/objects/delete.js +1 -1
  86. package/dist/lib/objects/get.js +1 -1
  87. package/dist/lib/objects/info.js +1 -1
  88. package/dist/lib/objects/list-versions.js +1 -1
  89. package/dist/lib/objects/list.js +1 -1
  90. package/dist/lib/objects/purge.js +1 -1
  91. package/dist/lib/objects/put.js +1 -1
  92. package/dist/lib/objects/restore-deleted.js +1 -1
  93. package/dist/lib/objects/restore-info.js +1 -1
  94. package/dist/lib/objects/restore.js +1 -1
  95. package/dist/lib/objects/set-access.js +1 -1
  96. package/dist/lib/objects/set.js +1 -1
  97. package/dist/lib/organizations/create.js +1 -1
  98. package/dist/lib/organizations/delete.js +1 -1
  99. package/dist/lib/organizations/list.js +1 -1
  100. package/dist/lib/organizations/select.js +1 -1
  101. package/dist/lib/presign.js +1 -1
  102. package/dist/lib/rm.js +1 -1
  103. package/dist/lib/snapshots/delete.js +1 -1
  104. package/dist/lib/snapshots/list.js +1 -1
  105. package/dist/lib/snapshots/take.js +1 -1
  106. package/dist/lib/stat.js +1 -1
  107. package/dist/lib/telemetry/disable.js +1 -1
  108. package/dist/lib/telemetry/enable.js +1 -1
  109. package/dist/lib/telemetry/status.js +1 -1
  110. package/dist/lib/touch.js +1 -1
  111. package/dist/lib/update.js +1 -1
  112. package/dist/lib/usage.js +1 -1
  113. package/dist/lib/whoami.js +1 -1
  114. package/dist/specs.yaml +25 -0
  115. package/dist/utils/analytics.js +1 -1
  116. package/dist/utils/bucket-info.js +1 -1
  117. package/dist/utils/exit.js +1 -1
  118. package/dist/utils/telemetry.js +1 -1
  119. package/dist/utils/update-check.js +1 -1
  120. package/package.json +2 -2
  121. package/dist/chunk-L5TE7GWK.js +0 -1
  122. /package/dist/{chunk-2AC5S3JV.js → chunk-ILMD5XON.js} +0 -0
package/README.md CHANGED
@@ -75,6 +75,7 @@ tigris init [flags]
75
75
  | `--agent` | Print a setup recipe for an AI coding agent to follow instead of running the interactive wizard |
76
76
 
77
77
  **Examples:**
78
+
78
79
  ```bash
79
80
  tigris init
80
81
  npx tigris init
@@ -96,6 +97,7 @@ tigris configure [flags]
96
97
  | `-e, --endpoint` | Tigris API endpoint (default: https://t3.storage.dev) |
97
98
 
98
99
  **Examples:**
100
+
99
101
  ```bash
100
102
  tigris configure --access-key tid_AaBb --access-secret tsec_XxYy
101
103
  tigris configure --endpoint https://custom.endpoint.dev
@@ -128,6 +130,7 @@ tigris login oauth
128
130
  ```
129
131
 
130
132
  **Examples:**
133
+
131
134
  ```bash
132
135
  tigris login oauth
133
136
  ```
@@ -146,6 +149,7 @@ tigris login credentials [flags]
146
149
  | `-secret, --access-secret` | Your secret access key (will prompt if not provided) |
147
150
 
148
151
  **Examples:**
152
+
149
153
  ```bash
150
154
  tigris login credentials --access-key tid_AaBb --access-secret tsec_XxYy
151
155
  tigris login credentials
@@ -160,6 +164,7 @@ tigris whoami
160
164
  ```
161
165
 
162
166
  **Examples:**
167
+
163
168
  ```bash
164
169
  tigris whoami
165
170
  ```
@@ -179,6 +184,7 @@ tigris usage [flags]
179
184
  | `--format` | Output format (default: table) |
180
185
 
181
186
  **Examples:**
187
+
182
188
  ```bash
183
189
  tigris usage
184
190
  tigris usage --month 2026-09
@@ -195,6 +201,7 @@ tigris update
195
201
  ```
196
202
 
197
203
  **Examples:**
204
+
198
205
  ```bash
199
206
  tigris update
200
207
  ```
@@ -208,6 +215,7 @@ tigris logout
208
215
  ```
209
216
 
210
217
  **Examples:**
218
+
211
219
  ```bash
212
220
  tigris logout
213
221
  ```
@@ -233,6 +241,7 @@ tigris credentials test [flags]
233
241
  | `-b, --bucket` | Bucket name to test access against (optional) |
234
242
 
235
243
  **Examples:**
244
+
236
245
  ```bash
237
246
  tigris credentials test
238
247
  tigris credentials test --bucket my-bucket
@@ -257,6 +266,7 @@ tigris telemetry status
257
266
  ```
258
267
 
259
268
  **Examples:**
269
+
260
270
  ```bash
261
271
  tigris telemetry status
262
272
  ```
@@ -270,6 +280,7 @@ tigris telemetry disable
270
280
  ```
271
281
 
272
282
  **Examples:**
283
+
273
284
  ```bash
274
285
  tigris telemetry disable
275
286
  ```
@@ -283,6 +294,7 @@ tigris telemetry enable
283
294
  ```
284
295
 
285
296
  **Examples:**
297
+
286
298
  ```bash
287
299
  tigris telemetry enable
288
300
  ```
@@ -304,6 +316,7 @@ tigris ls [path] [flags]
304
316
  | `--source` | List objects from a specific storage source on buckets with shadow migration enabled |
305
317
 
306
318
  **Examples:**
319
+
307
320
  ```bash
308
321
  tigris ls
309
322
  tigris ls my-bucket
@@ -326,12 +339,14 @@ tigris mk <path> [flags]
326
339
  | `-s, --enable-snapshots` | Enable snapshots for the bucket (only applies when creating a bucket) (default: false) |
327
340
  | `--allow-object-acl` | Allow per-object ACLs on the bucket (only applies when creating a bucket) (default: false) |
328
341
  | `--enable-directory-listing` | Enable directory listing, relevant for public buckets (only applies when creating a bucket) (default: false) |
342
+ | `--global-user-metadata` | Replicate object user metadata to every region so metadata listings work from anywhere. Cannot be changed after creation (only applies when creating a bucket) (default: false) |
329
343
  | `-t, --default-tier` | Default storage tier (only applies when creating a bucket) (default: STANDARD) |
330
344
  | `-l, --locations` | Location for the bucket (only applies when creating a bucket) (default: global) |
331
345
  | `-fork, --fork-of` | Create this bucket as a fork (copy-on-write clone) of the named source bucket |
332
346
  | `-source-snap, --source-snapshot` | 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 |
333
347
 
334
348
  **Examples:**
349
+
335
350
  ```bash
336
351
  tigris mk my-bucket
337
352
  tigris mk my-bucket --access public --region iad
@@ -352,6 +367,7 @@ tigris touch <path>
352
367
  ```
353
368
 
354
369
  **Examples:**
370
+
355
371
  ```bash
356
372
  tigris touch my-bucket/placeholder.txt
357
373
  tigris touch t3://my-bucket/logs/
@@ -372,6 +388,7 @@ tigris stat [path] [flags]
372
388
  | `--version-id` | Object version id to stat (requires bucket versioning). Omit to stat the latest version |
373
389
 
374
390
  **Examples:**
391
+
375
392
  ```bash
376
393
  tigris stat
377
394
  tigris stat t3://my-bucket
@@ -396,6 +413,7 @@ tigris presign <path> [flags]
396
413
  | `-snapshot, --snapshot-version` | 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. |
397
414
 
398
415
  **Examples:**
416
+
399
417
  ```bash
400
418
  tigris presign my-bucket/file.txt
401
419
  tigris presign t3://my-bucket/report.pdf --method put --expires-in 7200
@@ -418,6 +436,7 @@ tigris cp <src> <dest> [flags]
418
436
  | `--cache-control` | Cache-Control header stored with uploaded objects (only applies to local-to-remote uploads) |
419
437
 
420
438
  **Examples:**
439
+
421
440
  ```bash
422
441
  tigris cp ./file.txt t3://my-bucket/file.txt
423
442
  tigris cp ./logo.png t3://my-bucket/logo.png --access public
@@ -442,6 +461,7 @@ tigris mv <src> <dest> [flags]
442
461
  | `-f, --force` | Skip confirmation prompts (alias for --yes) |
443
462
 
444
463
  **Examples:**
464
+
445
465
  ```bash
446
466
  tigris mv t3://my-bucket/old.txt t3://my-bucket/new.txt -f
447
467
  tigris mv t3://my-bucket/old-dir/ t3://my-bucket/new-dir/ -rf
@@ -463,6 +483,7 @@ tigris rm <path> [flags]
463
483
  | `-f, --force` | Skip confirmation prompts (alias for --yes) |
464
484
 
465
485
  **Examples:**
486
+
466
487
  ```bash
467
488
  tigris rm t3://my-bucket/file.txt -f
468
489
  tigris rm t3://my-bucket/folder/ -rf
@@ -486,6 +507,7 @@ tigris bundle <bucket> [flags]
486
507
  | `--on-error` | How to handle missing objects. 'skip' omits them, 'fail' aborts the request (default: skip) |
487
508
 
488
509
  **Examples:**
510
+
489
511
  ```bash
490
512
  tigris bundle my-bucket --keys key1.jpg,key2.jpg --output archive.tar
491
513
  tigris bundle my-bucket --keys keys.txt --output archive.tar
@@ -518,6 +540,7 @@ tigris organizations list [flags]
518
540
  | `-i, --select` | Interactive selection mode |
519
541
 
520
542
  **Examples:**
543
+
521
544
  ```bash
522
545
  tigris orgs list
523
546
  tigris orgs list --format json
@@ -532,6 +555,7 @@ tigris organizations create <name>
532
555
  ```
533
556
 
534
557
  **Examples:**
558
+
535
559
  ```bash
536
560
  tigris orgs create my-org
537
561
  ```
@@ -545,6 +569,7 @@ tigris organizations select <name>
545
569
  ```
546
570
 
547
571
  **Examples:**
572
+
548
573
  ```bash
549
574
  tigris orgs select my-org
550
575
  ```
@@ -562,6 +587,7 @@ tigris organizations delete [id] [flags]
562
587
  | `-y, --yes` | Skip confirmation prompts |
563
588
 
564
589
  **Examples:**
590
+
565
591
  ```bash
566
592
  tigris orgs delete
567
593
  tigris orgs delete <org-id> --yes
@@ -611,6 +637,7 @@ tigris buckets list [flags]
611
637
  | `-pt, --page-token` | Pagination token from a previous request to fetch the next page |
612
638
 
613
639
  **Examples:**
640
+
614
641
  ```bash
615
642
  tigris buckets list
616
643
  tigris buckets list --format json
@@ -628,25 +655,31 @@ Create a new bucket with optional access, tier, and location settings
628
655
  tigris buckets create [name] [flags]
629
656
  ```
630
657
 
631
- | Flag | Description |
632
- | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
633
- | `-a, --access` | Access level (default: private) |
634
- | `--public` | Shorthand for --access public |
635
- | `-s, --enable-snapshots` | Enable snapshots for the bucket (default: false) |
636
- | `--allow-object-acl` | Allow per-object ACLs on the bucket (default: false) |
637
- | `--enable-directory-listing` | Enable directory listing, relevant for public buckets (default: false) |
638
- | `-t, --default-tier` | Choose the default tier for the bucket (default: STANDARD) |
639
- | `-l, --locations` | Location for the bucket (default: global) |
640
- | `-fork, --fork-of` | Create this bucket as a fork (copy-on-write clone) of the named source bucket |
641
- | `-source-snap, --source-snapshot` | 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 |
658
+ | Flag | Description |
659
+ | --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
660
+ | `-a, --access` | Access level (default: private) |
661
+ | `--public` | Shorthand for --access public |
662
+ | `-s, --enable-snapshots` | Enable snapshots for the bucket (default: false) |
663
+ | `--allow-object-acl` | Allow per-object ACLs on the bucket (default: false) |
664
+ | `--enable-directory-listing` | Enable directory listing, relevant for public buckets (default: false) |
665
+ | `--global-user-metadata` | Replicate object user metadata to every region so metadata listings work from anywhere. Cannot be changed after creation (default: false) |
666
+ | `--soft-delete` | Enable soft delete so deleted objects can be recovered within the retention window. Requires --retention-days. Change it later with "tigris buckets set --soft-delete" (default: false) |
667
+ | `--retention-days` | Number of days (7-90) to retain soft-deleted objects. Requires --soft-delete |
668
+ | `-t, --default-tier` | Choose the default tier for the bucket (default: STANDARD) |
669
+ | `-l, --locations` | Location for the bucket (default: global) |
670
+ | `-fork, --fork-of` | Create this bucket as a fork (copy-on-write clone) of the named source bucket |
671
+ | `-source-snap, --source-snapshot` | 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 |
642
672
 
643
673
  **Examples:**
674
+
644
675
  ```bash
645
676
  tigris buckets create my-bucket
646
677
  tigris buckets create my-bucket --access public --locations iad
647
678
  tigris buckets create my-bucket --enable-snapshots --default-tier STANDARD_IA
648
679
  tigris buckets create my-bucket --allow-object-acl
649
680
  tigris buckets create my-bucket --public --enable-directory-listing
681
+ tigris buckets create my-bucket --global-user-metadata
682
+ tigris buckets create my-bucket --soft-delete --retention-days 30
650
683
  tigris buckets create my-fork --fork-of my-bucket
651
684
  tigris buckets create my-fork --fork-of my-bucket --source-snapshot 1765889000501544464
652
685
  ```
@@ -664,6 +697,7 @@ tigris buckets rebase <fork> [flags]
664
697
  | `-y, --yes` | Skip confirmation prompts |
665
698
 
666
699
  **Examples:**
700
+
667
701
  ```bash
668
702
  tigris buckets rebase my-fork
669
703
  tigris buckets rebase my-fork --yes
@@ -684,6 +718,7 @@ tigris buckets merge <fork> [flags]
684
718
  | `-from-snap, --from-snapshot` | 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) |
685
719
 
686
720
  **Examples:**
721
+
687
722
  ```bash
688
723
  tigris buckets merge my-fork
689
724
  tigris buckets merge my-fork --into my-bucket
@@ -704,6 +739,7 @@ tigris buckets get <name> [flags]
704
739
  | `--format` | Output format (default: table) |
705
740
 
706
741
  **Examples:**
742
+
707
743
  ```bash
708
744
  tigris buckets get my-bucket
709
745
  ```
@@ -722,6 +758,7 @@ tigris buckets delete <name> [flags]
722
758
  | `--force` | Skip confirmation prompts (alias for --yes) |
723
759
 
724
760
  **Examples:**
761
+
725
762
  ```bash
726
763
  tigris buckets delete my-bucket --yes
727
764
  tigris buckets delete bucket-a,bucket-b --yes
@@ -736,6 +773,7 @@ tigris buckets restore <name>
736
773
  ```
737
774
 
738
775
  **Examples:**
776
+
739
777
  ```bash
740
778
  tigris buckets restore my-bucket
741
779
  ```
@@ -754,6 +792,7 @@ tigris buckets purge <name> [flags]
754
792
  | `--force` | Skip confirmation prompts (alias for --yes) |
755
793
 
756
794
  **Examples:**
795
+
757
796
  ```bash
758
797
  tigris buckets purge my-bucket --yes
759
798
  tigris buckets purge bucket-a,bucket-b --yes
@@ -782,6 +821,7 @@ tigris buckets set <name> [flags]
782
821
  | `--enable-additional-headers` | Enable additional HTTP headers (X-Content-Type-Options nosniff) |
783
822
 
784
823
  **Examples:**
824
+
785
825
  ```bash
786
826
  tigris buckets set my-bucket --access public
787
827
  tigris buckets set my-bucket --default-tier GLACIER
@@ -800,6 +840,7 @@ tigris buckets enable-snapshots <name>
800
840
  ```
801
841
 
802
842
  **Examples:**
843
+
803
844
  ```bash
804
845
  tigris buckets enable-snapshots my-bucket
805
846
  ```
@@ -813,6 +854,7 @@ tigris buckets disable-snapshots <name>
813
854
  ```
814
855
 
815
856
  **Examples:**
857
+
816
858
  ```bash
817
859
  tigris buckets disable-snapshots my-bucket
818
860
  ```
@@ -830,6 +872,7 @@ tigris buckets set-locations <name> [flags]
830
872
  | `-l, --locations` | Bucket location |
831
873
 
832
874
  **Examples:**
875
+
833
876
  ```bash
834
877
  tigris buckets set-locations my-bucket --locations iad
835
878
  tigris buckets set-locations my-bucket --locations iad,fra
@@ -844,20 +887,23 @@ Configure data migration from an external S3-compatible source bucket. Tigris wi
844
887
  tigris buckets set-migration <name> [flags]
845
888
  ```
846
889
 
847
- | Flag | Description |
848
- | ----------------------- | --------------------------------------------------------------- |
849
- | `-b, --bucket` | Name of the source bucket to migrate from |
850
- | `-e, --endpoint` | Endpoint URL of the source S3-compatible service |
851
- | `-r, --region` | Region of the source bucket |
852
- | `-key, --access-key` | Access key for the source bucket |
853
- | `-secret, --secret-key` | Secret key for the source bucket |
854
- | `--write-through` | Enable write-through mode (writes go to both source and Tigris) |
855
- | `--disable` | Disable migration and clear all migration settings |
890
+ | Flag | Description |
891
+ | ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
892
+ | `-b, --bucket` | Name of the source bucket to migrate from |
893
+ | `-e, --endpoint` | Endpoint URL of the source S3-compatible service |
894
+ | `-r, --region` | Region of the source bucket |
895
+ | `-key, --access-key` | Access key for the source bucket |
896
+ | `-secret, --secret-key` | Secret key for the source bucket |
897
+ | `--write-through` | Enable write-through mode (writes go to both source and Tigris) |
898
+ | `--skip-patterns` | Object keys never copied into Tigris, on write or on a read miss (comma-separated). Writes still go to the source bucket. Each pattern matches the whole key, and `*` matches any characters including `/`, e.g. `tmp/*`, `*.tmp`, `manifest.json`. Up to 32 patterns of 512 bytes. Settings are replaced as a whole, so omitting this clears existing patterns |
899
+ | `--disable` | Disable migration and clear all migration settings |
856
900
 
857
901
  **Examples:**
902
+
858
903
  ```bash
859
904
  tigris buckets set-migration my-bucket --bucket source-bucket --endpoint https://s3.amazonaws.com --region us-east-1 --access-key AKIA... --secret-key wJal...
860
905
  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
906
+ 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 --skip-patterns 'tmp/*,*.tmp'
861
907
  tigris buckets set-migration my-bucket --disable
862
908
  ```
863
909
 
@@ -874,6 +920,7 @@ tigris buckets migrate <path> [flags]
874
920
  | `--max-in-flight-gb` | Max total gigabytes of scheduled-but-unconfirmed migrations to keep in flight. Accepts 1-100 (default: 50) |
875
921
 
876
922
  **Examples:**
923
+
877
924
  ```bash
878
925
  tigris buckets migrate my-bucket
879
926
  tigris buckets migrate my-bucket/images/
@@ -904,6 +951,7 @@ tigris buckets lifecycle list <name> [flags]
904
951
  | `--format` | Output format (default: table) |
905
952
 
906
953
  **Examples:**
954
+
907
955
  ```bash
908
956
  tigris buckets lifecycle list my-bucket
909
957
  tigris buckets lifecycle list my-bucket --json
@@ -928,6 +976,7 @@ tigris buckets lifecycle create <name> [flags]
928
976
  | `--disable` | Create the rule in a disabled state |
929
977
 
930
978
  **Examples:**
979
+
931
980
  ```bash
932
981
  tigris buckets lifecycle create my-bucket --storage-class STANDARD_IA --days 30
933
982
  tigris buckets lifecycle create my-bucket --prefix logs/ --storage-class GLACIER --days 90
@@ -955,6 +1004,7 @@ tigris buckets lifecycle edit <name> <id> [flags]
955
1004
  | `--disable` | Disable the rule (does not remove it) |
956
1005
 
957
1006
  **Examples:**
1007
+
958
1008
  ```bash
959
1009
  tigris buckets lifecycle edit my-bucket abc123 --days 60
960
1010
  tigris buckets lifecycle edit my-bucket abc123 --expire-days 90
@@ -981,6 +1031,7 @@ tigris buckets set-notifications <name> [flags]
981
1031
  | `--reset` | Clear all notification settings on the bucket |
982
1032
 
983
1033
  **Examples:**
1034
+
984
1035
  ```bash
985
1036
  tigris buckets set-notifications my-bucket --url https://example.com/webhook
986
1037
  tigris buckets set-notifications my-bucket --url https://example.com/webhook --token secret123
@@ -1010,6 +1061,7 @@ tigris buckets set-cors <name> [flags]
1010
1061
  | `--reset` | Clear all CORS rules on the bucket |
1011
1062
 
1012
1063
  **Examples:**
1064
+
1013
1065
  ```bash
1014
1066
  tigris buckets set-cors my-bucket --origins '*' --methods GET,HEAD
1015
1067
  tigris buckets set-cors my-bucket --origins https://example.com --methods GET,POST --headers Content-Type,Authorization --max-age 3600
@@ -1035,6 +1087,7 @@ tigris buckets share <name> [flags]
1035
1087
  | `--reset` | Remove all shares from the bucket |
1036
1088
 
1037
1089
  **Examples:**
1090
+
1038
1091
  ```bash
1039
1092
  tigris buckets share my-bucket --organization --role ReadOnly
1040
1093
  tigris buckets share my-bucket --team tmid_MQQUhV --role Editor
@@ -1069,6 +1122,7 @@ tigris snapshots list <name> [flags]
1069
1122
  | `-pt, --page-token` | Pagination token from a previous request to fetch the next page |
1070
1123
 
1071
1124
  **Examples:**
1125
+
1072
1126
  ```bash
1073
1127
  tigris snapshots list my-bucket
1074
1128
  tigris snapshots list my-bucket --format json
@@ -1083,6 +1137,7 @@ tigris snapshots take <name> [snapshot-name]
1083
1137
  ```
1084
1138
 
1085
1139
  **Examples:**
1140
+
1086
1141
  ```bash
1087
1142
  tigris snapshots take my-bucket
1088
1143
  tigris snapshots take my-bucket my-snapshot
@@ -1102,6 +1157,7 @@ tigris snapshots delete <name> <version> [flags]
1102
1157
  | `--force` | Skip confirmation prompts (alias for --yes) |
1103
1158
 
1104
1159
  **Examples:**
1160
+
1105
1161
  ```bash
1106
1162
  tigris snapshots delete my-bucket 1765889000501544464 --yes
1107
1163
  tigris snapshots delete my-bucket 1765889000501544464,1765889000501544465 --yes
@@ -1145,6 +1201,7 @@ tigris objects list <bucket> [flags]
1145
1201
  | `--deleted` | 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 |
1146
1202
 
1147
1203
  **Examples:**
1204
+
1148
1205
  ```bash
1149
1206
  tigris objects list my-bucket
1150
1207
  tigris objects list t3://my-bucket
@@ -1173,6 +1230,7 @@ tigris objects list-versions <bucket> [flags]
1173
1230
  | `--deleted` | List the recoverable versions of soft-deleted objects. Use the version id with "tigris objects restore-deleted" or "tigris objects purge" |
1174
1231
 
1175
1232
  **Examples:**
1233
+
1176
1234
  ```bash
1177
1235
  tigris objects list-versions my-bucket
1178
1236
  tigris objects list-versions t3://my-bucket/logs/
@@ -1197,6 +1255,7 @@ tigris objects get <bucket> [key] [flags]
1197
1255
  | `--version-id` | Object version id to download (requires bucket versioning). Omit to download the latest version |
1198
1256
 
1199
1257
  **Examples:**
1258
+
1200
1259
  ```bash
1201
1260
  tigris objects get my-bucket config.json
1202
1261
  tigris objects get t3://my-bucket/config.json
@@ -1219,6 +1278,7 @@ tigris objects put <bucket> [key] [file] [flags]
1219
1278
  | `--format` | Output format (default: table) |
1220
1279
 
1221
1280
  **Examples:**
1281
+
1222
1282
  ```bash
1223
1283
  tigris objects put my-bucket report.pdf ./report.pdf
1224
1284
  tigris objects put t3://my-bucket/report.pdf ./report.pdf
@@ -1244,6 +1304,7 @@ tigris objects delete <bucket> [key] [flags]
1244
1304
  | `--force` | Skip confirmation prompts (alias for --yes) |
1245
1305
 
1246
1306
  **Examples:**
1307
+
1247
1308
  ```bash
1248
1309
  tigris objects delete my-bucket old-file.txt --yes
1249
1310
  tigris objects delete t3://my-bucket/old-file.txt --yes
@@ -1266,6 +1327,7 @@ tigris objects set <bucket> [key] [flags]
1266
1327
  | `-n, --new-key` | Rename the object to a new key |
1267
1328
 
1268
1329
  **Examples:**
1330
+
1269
1331
  ```bash
1270
1332
  tigris objects set my-bucket my-file.txt --access public
1271
1333
  tigris objects set t3://my-bucket/my-file.txt --access public
@@ -1285,6 +1347,7 @@ tigris objects set-access <bucket> [key] [access] [flags]
1285
1347
  | `--format` | Output format (default: table) |
1286
1348
 
1287
1349
  **Examples:**
1350
+
1288
1351
  ```bash
1289
1352
  tigris objects set-access my-bucket my-file.txt public
1290
1353
  tigris objects set-access t3://my-bucket/my-file.txt private
@@ -1305,6 +1368,7 @@ tigris objects info <bucket> [key] [flags]
1305
1368
  | `--version-id` | Object version id (requires bucket versioning). Omit to read the latest version |
1306
1369
 
1307
1370
  **Examples:**
1371
+
1308
1372
  ```bash
1309
1373
  tigris objects info my-bucket report.pdf
1310
1374
  tigris objects info t3://my-bucket/report.pdf
@@ -1328,6 +1392,7 @@ tigris objects restore <bucket> [key] [flags]
1328
1392
  | `--format` | Output format (default: table) |
1329
1393
 
1330
1394
  **Examples:**
1395
+
1331
1396
  ```bash
1332
1397
  tigris objects restore my-bucket archived.bin
1333
1398
  tigris objects restore my-bucket archived.bin --days 3
@@ -1350,6 +1415,7 @@ tigris objects restore-info <bucket> [key] [flags]
1350
1415
  | `--format` | Output format (default: table) |
1351
1416
 
1352
1417
  **Examples:**
1418
+
1353
1419
  ```bash
1354
1420
  tigris objects restore-info my-bucket archived.bin
1355
1421
  tigris objects restore-info t3://my-bucket/archived.bin --format json
@@ -1370,6 +1436,7 @@ tigris objects restore-deleted <bucket> [key] [flags]
1370
1436
  | `--format` | Output format (default: table) |
1371
1437
 
1372
1438
  **Examples:**
1439
+
1373
1440
  ```bash
1374
1441
  tigris objects restore-deleted my-bucket report.pdf --version-id 1787749774802410496
1375
1442
  tigris objects restore-deleted t3://my-bucket/report.pdf --version-id 1787749774802410496
@@ -1391,6 +1458,7 @@ tigris objects purge <bucket> [key] [flags]
1391
1458
  | `--format` | Output format (default: table) |
1392
1459
 
1393
1460
  **Examples:**
1461
+
1394
1462
  ```bash
1395
1463
  tigris objects purge my-bucket report.pdf --version-id 1787749774802410496 --yes
1396
1464
  tigris objects purge t3://my-bucket/report.pdf --version-id 1787749774802410496 --yes
@@ -1428,6 +1496,7 @@ tigris access-keys list [flags]
1428
1496
  | `-pt, --page-token` | Pagination token from a previous request to fetch the next page |
1429
1497
 
1430
1498
  **Examples:**
1499
+
1431
1500
  ```bash
1432
1501
  tigris access-keys list
1433
1502
  ```
@@ -1451,6 +1520,7 @@ tigris access-keys create <name> [flags]
1451
1520
  | `--for` | 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 (default: tigris) |
1452
1521
 
1453
1522
  **Examples:**
1523
+
1454
1524
  ```bash
1455
1525
  tigris access-keys create my-ci-key
1456
1526
  tigris access-keys create my-app --bucket my-app-bucket --role Editor --env
@@ -1472,6 +1542,7 @@ tigris access-keys delete <id> [flags]
1472
1542
  | `--force` | Skip confirmation prompts (alias for --yes) |
1473
1543
 
1474
1544
  **Examples:**
1545
+
1475
1546
  ```bash
1476
1547
  tigris access-keys delete tid_AaBbCcDdEeFf --yes
1477
1548
  tigris access-keys delete tid_AaBb,tid_CcDd --yes
@@ -1486,6 +1557,7 @@ tigris access-keys get <id>
1486
1557
  ```
1487
1558
 
1488
1559
  **Examples:**
1560
+
1489
1561
  ```bash
1490
1562
  tigris access-keys get tid_AaBbCcDdEeFf
1491
1563
  ```
@@ -1506,6 +1578,7 @@ tigris access-keys assign <id> [flags]
1506
1578
  | `--revoke-roles` | Revoke all bucket roles from the access key |
1507
1579
 
1508
1580
  **Examples:**
1581
+
1509
1582
  ```bash
1510
1583
  tigris access-keys assign tid_AaBb --bucket my-bucket --role Editor
1511
1584
  tigris access-keys assign tid_AaBb --bucket a,b --role Editor,ReadOnly
@@ -1526,6 +1599,7 @@ tigris access-keys set <id> [flags]
1526
1599
  | `--default-permissions` | Whether the key also gets the default-allowed operations (such as creating and listing buckets) on top of its roles and policies — the console's "Enable default permissions" toggle. Enabled unless disabled |
1527
1600
 
1528
1601
  **Examples:**
1602
+
1529
1603
  ```bash
1530
1604
  tigris access-keys set tid_AaBb --default-permissions disable
1531
1605
  tigris access-keys set tid_AaBb --default-permissions enable
@@ -1545,6 +1619,7 @@ tigris access-keys rotate <id> [flags]
1545
1619
  | `--force` | Skip confirmation prompts (alias for --yes) |
1546
1620
 
1547
1621
  **Examples:**
1622
+
1548
1623
  ```bash
1549
1624
  tigris access-keys rotate tid_AaBbCcDdEeFf --yes
1550
1625
  ```
@@ -1562,6 +1637,7 @@ tigris access-keys attach-policy <id> [flags]
1562
1637
  | `--policy-arn` | ARN of the policy to attach |
1563
1638
 
1564
1639
  **Examples:**
1640
+
1565
1641
  ```bash
1566
1642
  tigris access-keys attach-policy tid_AaBb --policy-arn arn:aws:iam::org_id:policy/my-policy
1567
1643
  tigris access-keys attach-policy tid_AaBb
@@ -1582,6 +1658,7 @@ tigris access-keys detach-policy <id> [flags]
1582
1658
  | `--force` | Skip confirmation prompts (alias for --yes) |
1583
1659
 
1584
1660
  **Examples:**
1661
+
1585
1662
  ```bash
1586
1663
  tigris access-keys detach-policy tid_AaBb --policy-arn arn:aws:iam::org_id:policy/my-policy --yes
1587
1664
  tigris access-keys detach-policy tid_AaBb
@@ -1602,6 +1679,7 @@ tigris access-keys list-policies <id> [flags]
1602
1679
  | `-pt, --page-token` | Pagination token from a previous request to fetch the next page |
1603
1680
 
1604
1681
  **Examples:**
1682
+
1605
1683
  ```bash
1606
1684
  tigris access-keys list-policies tid_AaBbCcDdEeFf
1607
1685
  ```
@@ -1646,6 +1724,7 @@ tigris iam policies list [flags]
1646
1724
  | `-pt, --page-token` | Pagination token from a previous request to fetch the next page |
1647
1725
 
1648
1726
  **Examples:**
1727
+
1649
1728
  ```bash
1650
1729
  tigris iam policies list
1651
1730
  ```
@@ -1663,6 +1742,7 @@ tigris iam policies get [resource] [flags]
1663
1742
  | `--format` | Output format (default: table) |
1664
1743
 
1665
1744
  **Examples:**
1745
+
1666
1746
  ```bash
1667
1747
  tigris iam policies get
1668
1748
  tigris iam policies get arn:aws:iam::org_id:policy/my-policy
@@ -1682,6 +1762,7 @@ tigris iam policies create <name> [flags]
1682
1762
  | `--description` | Policy description |
1683
1763
 
1684
1764
  **Examples:**
1765
+
1685
1766
  ```bash
1686
1767
  tigris iam policies create my-policy --document policy.json
1687
1768
  tigris iam policies create my-policy --document '{"Version":"2012-10-17","Statement":[...]}'
@@ -1702,6 +1783,7 @@ tigris iam policies edit [resource] [flags]
1702
1783
  | `--description` | Update policy description |
1703
1784
 
1704
1785
  **Examples:**
1786
+
1705
1787
  ```bash
1706
1788
  tigris iam policies edit --document policy.json
1707
1789
  tigris iam policies edit arn:aws:iam::org_id:policy/my-policy --document policy.json
@@ -1722,6 +1804,7 @@ tigris iam policies delete [resource] [flags]
1722
1804
  | `--force` | Skip confirmation prompts (alias for --yes) |
1723
1805
 
1724
1806
  **Examples:**
1807
+
1725
1808
  ```bash
1726
1809
  tigris iam policies delete
1727
1810
  tigris iam policies delete arn:aws:iam::org_id:policy/my-policy --yes
@@ -1740,6 +1823,7 @@ tigris iam policies link-key [resource] [flags]
1740
1823
  | `--id` | Access key ID to attach |
1741
1824
 
1742
1825
  **Examples:**
1826
+
1743
1827
  ```bash
1744
1828
  tigris iam policies link-key arn:aws:iam::org_id:policy/my-policy --id tid_AaBb
1745
1829
  tigris iam policies link-key
@@ -1760,6 +1844,7 @@ tigris iam policies unlink-key [resource] [flags]
1760
1844
  | `--force` | Skip confirmation prompts (alias for --yes) |
1761
1845
 
1762
1846
  **Examples:**
1847
+
1763
1848
  ```bash
1764
1849
  tigris iam policies unlink-key arn:aws:iam::org_id:policy/my-policy --id tid_AaBb --yes
1765
1850
  tigris iam policies unlink-key
@@ -1778,6 +1863,7 @@ tigris iam policies list-keys [resource] [flags]
1778
1863
  | `--format` | Output format (default: table) |
1779
1864
 
1780
1865
  **Examples:**
1866
+
1781
1867
  ```bash
1782
1868
  tigris iam policies list-keys arn:aws:iam::org_id:policy/my-policy
1783
1869
  tigris iam policies list-keys
@@ -1808,6 +1894,7 @@ tigris iam users list [flags]
1808
1894
  | `--format` | Output format (default: table) |
1809
1895
 
1810
1896
  **Examples:**
1897
+
1811
1898
  ```bash
1812
1899
  tigris iam users list
1813
1900
  tigris iam users list --format json
@@ -1826,6 +1913,7 @@ tigris iam users invite <email> [flags]
1826
1913
  | `-r, --role` | Role to assign to the invited user(s) (default: member) |
1827
1914
 
1828
1915
  **Examples:**
1916
+
1829
1917
  ```bash
1830
1918
  tigris iam users invite user@example.com
1831
1919
  tigris iam users invite user@example.com --role admin
@@ -1846,6 +1934,7 @@ tigris iam users revoke-invitation [resource] [flags]
1846
1934
  | `--force` | Skip confirmation prompts (alias for --yes) |
1847
1935
 
1848
1936
  **Examples:**
1937
+
1849
1938
  ```bash
1850
1939
  tigris iam users revoke-invitation
1851
1940
  tigris iam users revoke-invitation invitation_id --yes
@@ -1865,6 +1954,7 @@ tigris iam users update-role [resource] [flags]
1865
1954
  | `-r, --role` | Role(s) to assign (comma-separated). Each role pairs with the corresponding user ID. If one role is given, it applies to all users **(required)** |
1866
1955
 
1867
1956
  **Examples:**
1957
+
1868
1958
  ```bash
1869
1959
  tigris iam users update-role --role admin
1870
1960
  tigris iam users update-role user_id --role member
@@ -1886,6 +1976,7 @@ tigris iam users remove [resource] [flags]
1886
1976
  | `--force` | Skip confirmation prompts (alias for --yes) |
1887
1977
 
1888
1978
  **Examples:**
1979
+
1889
1980
  ```bash
1890
1981
  tigris iam users remove
1891
1982
  tigris iam users remove user@example.com --yes
@@ -1915,6 +2006,7 @@ tigris iam teams list [flags]
1915
2006
  | `--format` | Output format (default: table) |
1916
2007
 
1917
2008
  **Examples:**
2009
+
1918
2010
  ```bash
1919
2011
  tigris iam teams list
1920
2012
  tigris iam teams list --format json
@@ -1934,6 +2026,7 @@ tigris iam teams create <name> [flags]
1934
2026
  | `-m, --members` | Member email address(es) to add (comma-separated for multiple) |
1935
2027
 
1936
2028
  **Examples:**
2029
+
1937
2030
  ```bash
1938
2031
  tigris iam teams create engineering
1939
2032
  tigris iam teams create engineering --description 'Engineering team'
@@ -1955,6 +2048,7 @@ tigris iam teams edit <id> [flags]
1955
2048
  | `-m, --members` | Replace the team's members with these email address(es) (comma-separated for multiple) |
1956
2049
 
1957
2050
  **Examples:**
2051
+
1958
2052
  ```bash
1959
2053
  tigris iam teams edit team_id --name platform
1960
2054
  tigris iam teams edit team_id --description 'Platform team'