@tigrisdata/cli 3.12.2 → 3.14.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (129) hide show
  1. package/README.md +37 -4
  2. package/dist/auth/iam.js +1 -1
  3. package/dist/auth/provider.js +1 -1
  4. package/dist/browser/index.d.ts +18 -0
  5. package/dist/browser/index.js +463 -190
  6. package/dist/{chunk-WJWXPQBD.js → chunk-7BWCRJKU.js} +1 -1
  7. package/dist/{chunk-2NEE6EHO.js → chunk-A54TR6PZ.js} +1 -1
  8. package/dist/chunk-ABDWDZNK.js +4 -0
  9. package/dist/chunk-AG6GAJQM.js +5 -0
  10. package/dist/chunk-BTGWYSBL.js +2 -0
  11. package/dist/chunk-CIRQB45N.js +7 -0
  12. package/dist/{chunk-5HE5V2XI.js → chunk-CV77M3XG.js} +1 -1
  13. package/dist/{chunk-4Q7K4H7G.js → chunk-ELGUUOPX.js} +1 -1
  14. package/dist/{chunk-IUIKP2LU.js → chunk-EOCLTUJ4.js} +1 -1
  15. package/dist/chunk-GJLY3P2R.js +1 -0
  16. package/dist/chunk-K6JNY5VH.js +1 -0
  17. package/dist/{chunk-4IGHNCH2.js → chunk-P5DIPVOU.js} +1 -1
  18. package/dist/{chunk-RKQ4APOU.js → chunk-PAANXFCH.js} +1 -1
  19. package/dist/{chunk-ARZNOO2O.js → chunk-PGHGQCUB.js} +1 -1
  20. package/dist/{chunk-OLHVLEN3.js → chunk-QBBCW6FL.js} +1 -1
  21. package/dist/chunk-RAA7DIID.js +3 -0
  22. package/dist/{chunk-M63SODRY.js → chunk-X554SYWE.js} +1 -1
  23. package/dist/chunk-Y36SHW6I.js +14 -0
  24. package/dist/{chunk-RDGK5VBP.js → chunk-YJ2RZYU4.js} +1 -1
  25. package/dist/cli-core.js +1 -1
  26. package/dist/cli.js +1 -1
  27. package/dist/help.js +1 -0
  28. package/dist/index.js +1 -1
  29. package/dist/lib/access-keys/assign.js +1 -1
  30. package/dist/lib/access-keys/attach-policy.js +1 -1
  31. package/dist/lib/access-keys/create.js +2 -1
  32. package/dist/lib/access-keys/delete.js +1 -1
  33. package/dist/lib/access-keys/detach-policy.js +1 -1
  34. package/dist/lib/access-keys/get.js +1 -1
  35. package/dist/lib/access-keys/list-policies.js +1 -1
  36. package/dist/lib/access-keys/list.js +1 -1
  37. package/dist/lib/access-keys/roles.js +1 -0
  38. package/dist/lib/access-keys/rotate.js +1 -1
  39. package/dist/lib/buckets/create.js +1 -1
  40. package/dist/lib/buckets/delete.js +1 -1
  41. package/dist/lib/buckets/disable-snapshots.js +1 -1
  42. package/dist/lib/buckets/enable-snapshots.js +1 -1
  43. package/dist/lib/buckets/get.js +1 -1
  44. package/dist/lib/buckets/lifecycle/create.js +1 -1
  45. package/dist/lib/buckets/lifecycle/edit.js +1 -1
  46. package/dist/lib/buckets/lifecycle/list.js +1 -1
  47. package/dist/lib/buckets/lifecycle/shared.js +1 -1
  48. package/dist/lib/buckets/list.js +1 -1
  49. package/dist/lib/buckets/merge.js +1 -1
  50. package/dist/lib/buckets/migrate.js +1 -1
  51. package/dist/lib/buckets/rebase.js +1 -1
  52. package/dist/lib/buckets/restore.js +1 -1
  53. package/dist/lib/buckets/set-cors.js +1 -1
  54. package/dist/lib/buckets/set-locations.js +1 -1
  55. package/dist/lib/buckets/set-migration.js +1 -1
  56. package/dist/lib/buckets/set-notifications.js +1 -1
  57. package/dist/lib/buckets/set.js +1 -1
  58. package/dist/lib/buckets/share.js +1 -1
  59. package/dist/lib/bundle.js +1 -1
  60. package/dist/lib/configure/index.js +1 -1
  61. package/dist/lib/cp.js +1 -1
  62. package/dist/lib/credentials/test.js +1 -1
  63. package/dist/lib/iam/policies/create.js +1 -1
  64. package/dist/lib/iam/policies/delete.js +1 -1
  65. package/dist/lib/iam/policies/edit.js +1 -1
  66. package/dist/lib/iam/policies/get.js +1 -1
  67. package/dist/lib/iam/policies/link-key.js +1 -1
  68. package/dist/lib/iam/policies/list-keys.js +1 -1
  69. package/dist/lib/iam/policies/list.js +1 -1
  70. package/dist/lib/iam/policies/select-policy.js +1 -1
  71. package/dist/lib/iam/policies/unlink-key.js +1 -1
  72. package/dist/lib/iam/teams/create.js +1 -1
  73. package/dist/lib/iam/teams/edit.js +1 -1
  74. package/dist/lib/iam/teams/list.js +1 -1
  75. package/dist/lib/iam/teams/shared.js +1 -1
  76. package/dist/lib/iam/users/invite.js +1 -1
  77. package/dist/lib/iam/users/list.js +1 -1
  78. package/dist/lib/iam/users/remove.js +1 -1
  79. package/dist/lib/iam/users/revoke-invitation.js +1 -1
  80. package/dist/lib/iam/users/update-role.js +1 -1
  81. package/dist/lib/init/index.js +1 -1
  82. package/dist/lib/init/plan.js +1 -1
  83. package/dist/lib/login/credentials.js +1 -1
  84. package/dist/lib/login/oauth.js +1 -1
  85. package/dist/lib/login/select.js +1 -1
  86. package/dist/lib/logout.js +1 -1
  87. package/dist/lib/ls.js +1 -1
  88. package/dist/lib/mk.js +1 -1
  89. package/dist/lib/mv.js +1 -1
  90. package/dist/lib/objects/delete.js +1 -1
  91. package/dist/lib/objects/get.js +1 -1
  92. package/dist/lib/objects/info.js +1 -1
  93. package/dist/lib/objects/list-versions.js +1 -1
  94. package/dist/lib/objects/list.js +1 -1
  95. package/dist/lib/objects/purge.js +1 -1
  96. package/dist/lib/objects/put.js +1 -1
  97. package/dist/lib/objects/restore-deleted.js +1 -1
  98. package/dist/lib/objects/restore-info.js +1 -1
  99. package/dist/lib/objects/restore.js +1 -1
  100. package/dist/lib/objects/set-access.js +1 -1
  101. package/dist/lib/objects/set.js +1 -1
  102. package/dist/lib/organizations/create.js +1 -1
  103. package/dist/lib/organizations/list.js +1 -1
  104. package/dist/lib/organizations/select.js +1 -1
  105. package/dist/lib/presign.js +1 -1
  106. package/dist/lib/rm.js +1 -1
  107. package/dist/lib/snapshots/delete.js +1 -1
  108. package/dist/lib/snapshots/list.js +1 -1
  109. package/dist/lib/snapshots/take.js +1 -1
  110. package/dist/lib/stat.js +1 -1
  111. package/dist/lib/telemetry/disable.js +1 -1
  112. package/dist/lib/telemetry/enable.js +1 -1
  113. package/dist/lib/telemetry/status.js +1 -1
  114. package/dist/lib/touch.js +1 -1
  115. package/dist/lib/update.js +1 -1
  116. package/dist/lib/whoami.js +1 -1
  117. package/dist/specs.yaml +280 -19
  118. package/dist/utils/analytics.js +1 -1
  119. package/dist/utils/bucket-info.js +1 -1
  120. package/dist/utils/credentials-export.js +1 -0
  121. package/dist/utils/exit.js +1 -1
  122. package/dist/utils/telemetry.js +1 -1
  123. package/dist/utils/update-check.js +1 -1
  124. package/package.json +3 -3
  125. package/dist/chunk-DCSVQMPM.js +0 -2
  126. package/dist/chunk-F67MYOOP.js +0 -1
  127. package/dist/chunk-JELDAKLB.js +0 -30
  128. package/dist/chunk-JRLZXECQ.js +0 -5
  129. package/dist/chunk-NNZ3E7E5.js +0 -10
package/README.md CHANGED
@@ -412,6 +412,7 @@ tigris mv <src> <dest> [flags]
412
412
 
413
413
  | Flag | Description |
414
414
  |------|-------------|
415
+ | `-y, --yes` | Skip confirmation prompts |
415
416
  | `-r, --recursive` | Move directories recursively |
416
417
  | `-f, --force` | Skip confirmation prompts (alias for --yes) |
417
418
 
@@ -432,6 +433,7 @@ tigris rm <path> [flags]
432
433
 
433
434
  | Flag | Description |
434
435
  |------|-------------|
436
+ | `-y, --yes` | Skip confirmation prompts |
435
437
  | `-r, --recursive` | Remove directories recursively |
436
438
  | `-f, --force` | Skip confirmation prompts (alias for --yes) |
437
439
 
@@ -558,6 +560,8 @@ tigris buckets list [flags]
558
560
  | `--format` | Output format (default: table) |
559
561
  | `--forks-of` | Only list buckets that are forks of the named source bucket |
560
562
  | `--deleted` | Only list soft-deleted buckets |
563
+ | `--forks-only` | Only list buckets that are forks of another bucket |
564
+ | `--owner` | Only list buckets owned by this user, by username (an email address) |
561
565
  | `--limit` | Maximum number of items to return per page |
562
566
  | `-pt, --page-token` | Pagination token from a previous request to fetch the next page |
563
567
 
@@ -566,6 +570,8 @@ tigris buckets list [flags]
566
570
  tigris buckets list
567
571
  tigris buckets list --format json
568
572
  tigris buckets list --forks-of my-bucket
573
+ tigris buckets list --forks-only
574
+ tigris buckets list --owner alice@example.com
569
575
  tigris buckets list --deleted
570
576
  ```
571
577
 
@@ -605,9 +611,13 @@ tigris buckets create my-fork --fork-of my-bucket --source-snapshot 176588900050
605
611
  Update a fork with the latest changes from its source bucket
606
612
 
607
613
  ```
608
- tigris buckets rebase <fork>
614
+ tigris buckets rebase <fork> [flags]
609
615
  ```
610
616
 
617
+ | Flag | Description |
618
+ |------|-------------|
619
+ | `-y, --yes` | Skip confirmation prompts |
620
+
611
621
  **Examples:**
612
622
  ```bash
613
623
  tigris buckets rebase my-fork
@@ -624,6 +634,7 @@ tigris buckets merge <fork> [flags]
624
634
 
625
635
  | Flag | Description |
626
636
  |------|-------------|
637
+ | `-y, --yes` | Skip confirmation prompts |
627
638
  | `-source, --into` | Source bucket to merge into. Defaults to the fork's parent source bucket |
628
639
  | `-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) |
629
640
 
@@ -662,6 +673,7 @@ tigris buckets delete <name> [flags]
662
673
 
663
674
  | Flag | Description |
664
675
  |------|-------------|
676
+ | `-y, --yes` | Skip confirmation prompts |
665
677
  | `--force` | Skip confirmation prompts (alias for --yes) |
666
678
 
667
679
  **Examples:**
@@ -1022,6 +1034,7 @@ tigris snapshots delete <name> <version> [flags]
1022
1034
 
1023
1035
  | Flag | Description |
1024
1036
  |------|-------------|
1037
+ | `-y, --yes` | Skip confirmation prompts |
1025
1038
  | `--force` | Skip confirmation prompts (alias for --yes) |
1026
1039
 
1027
1040
  **Examples:**
@@ -1161,6 +1174,7 @@ tigris objects delete <bucket> [key] [flags]
1161
1174
 
1162
1175
  | Flag | Description |
1163
1176
  |------|-------------|
1177
+ | `-y, --yes` | Skip confirmation prompts |
1164
1178
  | `--version-id` | Hard-delete a specific object version (requires bucket versioning). Targets a single key. To destroy a soft-deleted version, use "tigris objects purge" |
1165
1179
  | `--all-versions` | Hard-delete every version and delete marker for the given key(s). Mutually exclusive with --version-id |
1166
1180
  | `--force` | Skip confirmation prompts (alias for --yes) |
@@ -1307,6 +1321,7 @@ tigris objects purge <bucket> [key] [flags]
1307
1321
 
1308
1322
  | Flag | Description |
1309
1323
  |------|-------------|
1324
+ | `-y, --yes` | Skip confirmation prompts |
1310
1325
  | `--version-id` | The soft-deleted version to destroy, from "tigris objects list-versions --deleted" **(required)** |
1311
1326
  | `--force` | Skip confirmation prompts (alias for --yes) |
1312
1327
  | `--format` | Output format (default: table) |
@@ -1324,7 +1339,7 @@ Create, list, inspect, delete, and assign roles to access keys. Access keys are
1324
1339
  | Command | Description |
1325
1340
  |---------|-------------|
1326
1341
  | `tigris access-keys list` (l) | List all access keys in the current organization |
1327
- | `tigris access-keys create` (c) | Create a new access key with the given name. Returns the key ID and secret (shown only once) |
1342
+ | `tigris access-keys create` (c) | 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) |
1328
1343
  | `tigris access-keys delete` (d) | Permanently delete an access key by its ID. This revokes all access immediately |
1329
1344
  | `tigris access-keys get` (g) | Show details for an access key including its name, creation date, and assigned bucket roles |
1330
1345
  | `tigris access-keys assign` (a) | 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 |
@@ -1354,15 +1369,26 @@ tigris access-keys list
1354
1369
 
1355
1370
  #### `tigris access-keys create` (c)
1356
1371
 
1357
- Create a new access key with the given name. Returns the key ID and secret (shown only once)
1372
+ 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)
1358
1373
 
1359
1374
  ```
1360
- tigris access-keys create <name>
1375
+ tigris access-keys create <name> [flags]
1361
1376
  ```
1362
1377
 
1378
+ | Flag | Description |
1379
+ |------|-------------|
1380
+ | `-b, --bucket` | Bucket name (can specify multiple, comma-separated). Each bucket is paired positionally with a --role value |
1381
+ | `-r, --role` | Role to assign (can specify multiple, comma-separated). Each role pairs with the corresponding --bucket value |
1382
+ | `--admin` | Grant admin access to all buckets in the organization |
1383
+ | `--env` | Write the credentials to a dotenv file, merging into it when it already exists. Defaults to ./.env. The secret is then not printed |
1384
+ | `--export` | Print the credentials as shell "export" lines and nothing else on stdout, for eval "$(tigris access-keys create <name> --export)" |
1385
+ | `--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) |
1386
+
1363
1387
  **Examples:**
1364
1388
  ```bash
1365
1389
  tigris access-keys create my-ci-key
1390
+ tigris access-keys create my-app --bucket my-app-bucket --role Editor --env
1391
+ eval "$(tigris access-keys create dev --bucket my-app-bucket --role Editor --export)"
1366
1392
  ```
1367
1393
 
1368
1394
  #### `tigris access-keys delete` (d)
@@ -1375,6 +1401,7 @@ tigris access-keys delete <id> [flags]
1375
1401
 
1376
1402
  | Flag | Description |
1377
1403
  |------|-------------|
1404
+ | `-y, --yes` | Skip confirmation prompts |
1378
1405
  | `--force` | Skip confirmation prompts (alias for --yes) |
1379
1406
 
1380
1407
  **Examples:**
@@ -1428,6 +1455,7 @@ tigris access-keys rotate <id> [flags]
1428
1455
 
1429
1456
  | Flag | Description |
1430
1457
  |------|-------------|
1458
+ | `-y, --yes` | Skip confirmation prompts |
1431
1459
  | `--force` | Skip confirmation prompts (alias for --yes) |
1432
1460
 
1433
1461
  **Examples:**
@@ -1463,6 +1491,7 @@ tigris access-keys detach-policy <id> [flags]
1463
1491
 
1464
1492
  | Flag | Description |
1465
1493
  |------|-------------|
1494
+ | `-y, --yes` | Skip confirmation prompts |
1466
1495
  | `--policy-arn` | ARN of the policy to detach |
1467
1496
  | `--force` | Skip confirmation prompts (alias for --yes) |
1468
1497
 
@@ -1603,6 +1632,7 @@ tigris iam policies delete [resource] [flags]
1603
1632
 
1604
1633
  | Flag | Description |
1605
1634
  |------|-------------|
1635
+ | `-y, --yes` | Skip confirmation prompts |
1606
1636
  | `--force` | Skip confirmation prompts (alias for --yes) |
1607
1637
 
1608
1638
  **Examples:**
@@ -1639,6 +1669,7 @@ tigris iam policies unlink-key [resource] [flags]
1639
1669
 
1640
1670
  | Flag | Description |
1641
1671
  |------|-------------|
1672
+ | `-y, --yes` | Skip confirmation prompts |
1642
1673
  | `--id` | Access key ID to detach |
1643
1674
  | `--force` | Skip confirmation prompts (alias for --yes) |
1644
1675
 
@@ -1725,6 +1756,7 @@ tigris iam users revoke-invitation [resource] [flags]
1725
1756
 
1726
1757
  | Flag | Description |
1727
1758
  |------|-------------|
1759
+ | `-y, --yes` | Skip confirmation prompts |
1728
1760
  | `--force` | Skip confirmation prompts (alias for --yes) |
1729
1761
 
1730
1762
  **Examples:**
@@ -1764,6 +1796,7 @@ tigris iam users remove [resource] [flags]
1764
1796
 
1765
1797
  | Flag | Description |
1766
1798
  |------|-------------|
1799
+ | `-y, --yes` | Skip confirmation prompts |
1767
1800
  | `--force` | Skip confirmation prompts (alias for --yes) |
1768
1801
 
1769
1802
  **Examples:**
package/dist/auth/iam.js CHANGED
@@ -1 +1 @@
1
- import{a as b,b as c}from"../chunk-DCSVQMPM.js";import"../chunk-JRLZXECQ.js";import"../chunk-4IGHNCH2.js";import"../chunk-D7WXNA2O.js";import"../chunk-NI4EYBQH.js";import"../chunk-RDGK5VBP.js";import"../chunk-DV3LCXRH.js";import"../chunk-F67MYOOP.js";import"../chunk-BMWWPXMU.js";import"../chunk-APJUJ6TW.js";import"../chunk-QPUL2AAI.js";import"../chunk-HBEO4D3T.js";import{a}from"../chunk-KJBSIIND.js";import"../chunk-F4AGJWCK.js";export{c as getIAMConfig,b as getOAuthIAMConfig,a as isFlyOrganization};
1
+ import{a as b,b as c}from"../chunk-BTGWYSBL.js";import{a}from"../chunk-KJBSIIND.js";import"../chunk-AG6GAJQM.js";import"../chunk-P5DIPVOU.js";import"../chunk-YJ2RZYU4.js";import"../chunk-D7WXNA2O.js";import"../chunk-NI4EYBQH.js";import"../chunk-APJUJ6TW.js";import"../chunk-K6JNY5VH.js";import"../chunk-BMWWPXMU.js";import"../chunk-DV3LCXRH.js";import"../chunk-QPUL2AAI.js";import"../chunk-HBEO4D3T.js";import"../chunk-F4AGJWCK.js";export{c as getIAMConfig,b as getOAuthIAMConfig,a as isFlyOrganization};
@@ -1 +1 @@
1
- import{a,b,c,d,e,f,g,h}from"../chunk-JRLZXECQ.js";import"../chunk-QPUL2AAI.js";import"../chunk-HBEO4D3T.js";import"../chunk-F4AGJWCK.js";export{c as getEnvCredentials,b as getEnvForcePathStyle,f as getStorageConfig,g as getStorageConfigWithOrg,a as getTigrisConfig,h as requireOAuthLogin,d as resetAutoLogin,e as resolveAuthMethod};
1
+ import{a,b,c,d,e,f,g,h,i}from"../chunk-AG6GAJQM.js";import"../chunk-QPUL2AAI.js";import"../chunk-HBEO4D3T.js";import"../chunk-F4AGJWCK.js";export{c as getEnvCredentials,b as getEnvForcePathStyle,f as getStorageConfig,h as getStorageConfigWithOrg,a as getTigrisConfig,i as requireOAuthLogin,d as resetAutoLogin,e as resolveAuthMethod,g as resolveEndpoints};
@@ -5,6 +5,11 @@ import { Volume } from 'memfs';
5
5
  interface Argument {
6
6
  name: string;
7
7
  description?: string;
8
+ /**
9
+ * Precise one-liner shown beside the argument in help. Falls back to
10
+ * `description`, which stays the full text for the generated docs.
11
+ */
12
+ helpText?: string;
8
13
  alias?: string;
9
14
  options?: string[] | Array<{
10
15
  name: string;
@@ -19,6 +24,8 @@ interface Argument {
19
24
  examples?: string[];
20
25
  /** Hard-removed: providing the flag exits with a redirect message. */
21
26
  removed?: boolean;
27
+ /** Still parsed, but not listed in help. */
28
+ hidden?: boolean;
22
29
  /** Soft-deprecated: still works, but flagged in help and superseded by `replaced_by`. */
23
30
  deprecated?: boolean;
24
31
  /** Replacement to suggest when a removed or deprecated argument or command is used. */
@@ -41,7 +48,16 @@ interface Messages {
41
48
  interface CommandSpec {
42
49
  name: string;
43
50
  description?: string;
51
+ /**
52
+ * Precise one-liner shown in the parent's command list. Falls back to
53
+ * `description`, which is shown in full on the command's own help page.
54
+ */
55
+ helpText?: string;
44
56
  alias?: string | string[];
57
+ /** Heading this command is listed under; one of the parent's `groups`. */
58
+ group?: string;
59
+ /** Headings for this command's subcommand list, in display order. */
60
+ groups?: string[];
45
61
  arguments?: Argument[];
46
62
  examples?: string[];
47
63
  commands?: CommandSpec[];
@@ -58,6 +74,8 @@ interface Specs {
58
74
  name: string;
59
75
  description: string;
60
76
  version: string;
77
+ /** Headings for the root command list, in display order. */
78
+ groups?: string[];
61
79
  definitions?: {
62
80
  global_arguments?: Argument[];
63
81
  [key: string]: unknown;