@tigrisdata/cli 2.6.1 → 2.7.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 (62) hide show
  1. package/README.md +248 -77
  2. package/dist/auth/client.js +1 -1
  3. package/dist/auth/config.js +1 -1
  4. package/dist/auth/s3-client.js +1 -1
  5. package/dist/auth/storage.js +1 -1
  6. package/dist/{chunk-NYAHHQ3A.js → chunk-7F4WI32C.js} +1 -1
  7. package/dist/chunk-BP52O7NB.js +1 -0
  8. package/dist/{chunk-WE6NZ2ZK.js → chunk-DC3ZKGQV.js} +1 -1
  9. package/dist/chunk-EXTBL5CE.js +12 -0
  10. package/dist/{chunk-IACJQZUD.js → chunk-HCOG24E2.js} +1 -1
  11. package/dist/chunk-LCWHZUZZ.js +1 -0
  12. package/dist/chunk-NYQG3EX3.js +8 -0
  13. package/dist/chunk-PRJKBTQP.js +2 -0
  14. package/dist/{chunk-PKWQDQLT.js → chunk-UUITLEOI.js} +1 -1
  15. package/dist/{chunk-DYTBLGO7.js → chunk-VT3KZHZZ.js} +1 -1
  16. package/dist/cli.js +1 -1
  17. package/dist/constants.js +1 -1
  18. package/dist/index.js +1 -1
  19. package/dist/lib/_stat.js +1 -1
  20. package/dist/lib/access-keys/assign.js +2 -2
  21. package/dist/lib/access-keys/create.js +2 -2
  22. package/dist/lib/access-keys/delete.js +2 -2
  23. package/dist/lib/access-keys/get.js +2 -2
  24. package/dist/lib/access-keys/list.js +2 -2
  25. package/dist/lib/buckets/create.js +1 -1
  26. package/dist/lib/buckets/delete.js +1 -1
  27. package/dist/lib/buckets/get.js +1 -1
  28. package/dist/lib/buckets/list.js +1 -1
  29. package/dist/lib/buckets/set.js +1 -1
  30. package/dist/lib/configure/index.js +1 -1
  31. package/dist/lib/cp.js +1 -1
  32. package/dist/lib/credentials/test.js +1 -1
  33. package/dist/lib/forks/create.js +1 -1
  34. package/dist/lib/forks/list.js +1 -1
  35. package/dist/lib/login/credentials.js +1 -1
  36. package/dist/lib/login/oauth.js +1 -1
  37. package/dist/lib/login/select.js +1 -1
  38. package/dist/lib/logout.js +1 -1
  39. package/dist/lib/ls.js +1 -1
  40. package/dist/lib/mk.js +1 -1
  41. package/dist/lib/mv.js +1 -1
  42. package/dist/lib/objects/delete.js +1 -1
  43. package/dist/lib/objects/get.js +1 -1
  44. package/dist/lib/objects/list.js +1 -1
  45. package/dist/lib/objects/put.js +1 -1
  46. package/dist/lib/organizations/create.js +2 -2
  47. package/dist/lib/organizations/list.js +2 -2
  48. package/dist/lib/organizations/select.js +3 -3
  49. package/dist/lib/rm.js +1 -1
  50. package/dist/lib/snapshots/list.js +1 -1
  51. package/dist/lib/snapshots/take.js +1 -1
  52. package/dist/lib/touch.js +1 -1
  53. package/dist/lib/whoami.js +1 -1
  54. package/dist/specs.yaml +244 -77
  55. package/dist/utils/path.js +1 -1
  56. package/dist/utils/update-check.js +1 -0
  57. package/package.json +3 -1
  58. package/postinstall.cjs +32 -0
  59. package/dist/chunk-4BZ377KV.js +0 -1
  60. package/dist/chunk-I3FOSZPG.js +0 -1
  61. package/dist/chunk-IY46B353.js +0 -12
  62. package/dist/chunk-TQWT7ROJ.js +0 -1
package/README.md CHANGED
@@ -18,29 +18,29 @@ Run `tigris help` to see all available commands, or `tigris <command> help` for
18
18
 
19
19
  ### Core Commands
20
20
 
21
- - `tigris ls [path]` - List buckets or objects in a bucket or path
22
- - `tigris mk <path>` - Create a bucket or a folder in a bucket
23
- - `tigris touch <path>` - Create an empty object in a bucket
24
- - `tigris cp <src> <dest>` - Copy a folder or an object
25
- - `tigris mv <src> <dest>` - Move a folder or an object
26
- - `tigris rm <path>` - Remove a bucket or a folder in a bucket or an object in a bucket or path
21
+ - `tigris ls [path]` - List all buckets (no arguments) or objects under a bucket/prefix path. Accepts bare names or t3:// URIs
22
+ - `tigris mk <path>` - Create a bucket (bare name) or a folder inside a bucket (bucket/folder/ with trailing slash)
23
+ - `tigris touch <path>` - Create an empty (zero-byte) object at the given bucket/key path
24
+ - `tigris cp <src> <dest>` - Copy files between local filesystem and Tigris, or between paths within Tigris. At least one side must be a remote t3:// path
25
+ - `tigris mv <src> <dest>` - Move (rename) objects within Tigris. Both source and destination must be remote t3:// paths
26
+ - `tigris rm <path>` - Remove a bucket, folder, or object from Tigris. A bare bucket name deletes the bucket itself
27
27
 
28
28
  ### Authentication
29
29
 
30
- - `tigris login` - Start a session. Use OAuth (default) or temporary credentials that override your saved config
31
- - `tigris logout` - End your session. Clears login state but keeps credentials from 'configure'
32
- - `tigris whoami` - Show information about the current user
33
- - `tigris configure` - Save credentials permanently. After running this, all commands work automatically
30
+ - `tigris login` - Start a session via OAuth (default) or temporary credentials. Session state is cleared on logout
31
+ - `tigris logout` - End the current session and clear login state. Credentials saved via 'configure' are kept
32
+ - `tigris whoami` - Print the currently authenticated user, organization, and auth method
33
+ - `tigris configure` - Save access-key credentials to ~/.tigris/config.json for persistent use across all commands
34
34
 
35
35
  ### Resources
36
36
 
37
- - `tigris organizations` - Manage organizations
38
- - `tigris access-keys` - Manage access keys
39
- - `tigris credentials` - Manage and test credentials
40
- - `tigris buckets` - Manage buckets
41
- - `tigris forks` - Manage forks
42
- - `tigris snapshots` - Manage snapshots
43
- - `tigris objects` - Manage objects
37
+ - `tigris organizations` - List, create, and switch between organizations. An organization is a workspace that contains your resources like buckets and access keys
38
+ - `tigris access-keys` - Create, list, inspect, delete, and assign roles to access keys. Access keys are credentials used for programmatic API access
39
+ - `tigris credentials` - Test whether your current credentials can reach Tigris and optionally verify access to a specific bucket
40
+ - `tigris buckets` - Create, inspect, update, and delete buckets. Buckets are top-level containers that hold objects
41
+ - `tigris forks` - List and create forks. A fork is a writable copy-on-write clone of a bucket, useful for testing or branching data
42
+ - `tigris snapshots` - List and take snapshots. A snapshot is a point-in-time, read-only copy of a bucket's state
43
+ - `tigris objects` - Low-level object operations for listing, downloading, uploading, and deleting individual objects in a bucket
44
44
 
45
45
  ---
46
46
 
@@ -48,7 +48,7 @@ Run `tigris help` to see all available commands, or `tigris <command> help` for
48
48
 
49
49
  ### `ls` | `list`
50
50
 
51
- List buckets or objects in a bucket or path
51
+ List all buckets (no arguments) or objects under a bucket/prefix path. Accepts bare names or t3:// URIs
52
52
 
53
53
  ```
54
54
  tigris ls [path]
@@ -56,13 +56,15 @@ tigris ls [path]
56
56
 
57
57
  **Examples:**
58
58
  ```bash
59
+ tigris ls
59
60
  tigris ls my-bucket
60
- tigris ls my-bucket/my-path
61
+ tigris ls my-bucket/images/
62
+ tigris ls t3://my-bucket/prefix/
61
63
  ```
62
64
 
63
65
  ### `mk` | `create`
64
66
 
65
- Create a bucket or a folder in a bucket
67
+ Create a bucket (bare name) or a folder inside a bucket (bucket/folder/ with trailing slash)
66
68
 
67
69
  ```
68
70
  tigris mk <path>
@@ -71,12 +73,13 @@ tigris mk <path>
71
73
  **Examples:**
72
74
  ```bash
73
75
  tigris mk my-bucket
74
- tigris mk my-bucket/my-path
76
+ tigris mk my-bucket/images/
77
+ tigris mk t3://my-bucket
75
78
  ```
76
79
 
77
80
  ### `touch`
78
81
 
79
- Create an empty object in a bucket
82
+ Create an empty (zero-byte) object at the given bucket/key path
80
83
 
81
84
  ```
82
85
  tigris touch <path>
@@ -84,26 +87,33 @@ tigris touch <path>
84
87
 
85
88
  **Examples:**
86
89
  ```bash
87
- tigris touch my-bucket/my-file.txt
90
+ tigris touch my-bucket/placeholder.txt
91
+ tigris touch t3://my-bucket/logs/
88
92
  ```
89
93
 
90
94
  ### `cp` | `copy`
91
95
 
92
- Copy a folder or an object
96
+ Copy files between local filesystem and Tigris, or between paths within Tigris. At least one side must be a remote t3:// path
93
97
 
94
98
  ```
95
- tigris cp <src> <dest>
99
+ tigris cp <src> <dest> [flags]
96
100
  ```
97
101
 
102
+ | Flag | Description |
103
+ |------|-------------|
104
+ | `-r, --recursive` | Copy directories recursively |
105
+
98
106
  **Examples:**
99
107
  ```bash
100
- tigris cp bucket/file.txt bucket/copy.txt
101
- tigris cp bucket/folder/ other-bucket/folder/
108
+ tigris cp ./file.txt t3://my-bucket/file.txt
109
+ tigris cp t3://my-bucket/file.txt ./local-copy.txt
110
+ tigris cp t3://my-bucket/src/ t3://my-bucket/dest/ -r
111
+ tigris cp ./images/ t3://my-bucket/images/ -r
102
112
  ```
103
113
 
104
114
  ### `mv` | `move`
105
115
 
106
- Move a folder or an object
116
+ Move (rename) objects within Tigris. Both source and destination must be remote t3:// paths
107
117
 
108
118
  ```
109
119
  tigris mv <src> <dest> [flags]
@@ -111,17 +121,19 @@ tigris mv <src> <dest> [flags]
111
121
 
112
122
  | Flag | Description |
113
123
  |------|-------------|
124
+ | `-r, --recursive` | Move directories recursively |
114
125
  | `-f, --force` | Skip confirmation prompt |
115
126
 
116
127
  **Examples:**
117
128
  ```bash
118
- tigris mv bucket/file.txt bucket/copy.txt
119
- tigris mv bucket/folder/ other-bucket/folder/
129
+ tigris mv t3://my-bucket/old.txt t3://my-bucket/new.txt -f
130
+ tigris mv t3://my-bucket/old-dir/ t3://my-bucket/new-dir/ -rf
131
+ tigris mv my-bucket/a.txt my-bucket/b.txt -f
120
132
  ```
121
133
 
122
134
  ### `rm` | `remove`
123
135
 
124
- Remove a bucket or a folder in a bucket or an object in a bucket or path
136
+ Remove a bucket, folder, or object from Tigris. A bare bucket name deletes the bucket itself
125
137
 
126
138
  ```
127
139
  tigris rm <path> [flags]
@@ -129,26 +141,28 @@ tigris rm <path> [flags]
129
141
 
130
142
  | Flag | Description |
131
143
  |------|-------------|
144
+ | `-r, --recursive` | Remove directories recursively |
132
145
  | `-f, --force` | Skip confirmation prompt |
133
146
 
134
147
  **Examples:**
135
148
  ```bash
136
- tigris rm my-bucket
137
- tigris rm my-bucket/my-path
138
- tigris rm my-bucket/my-path/*
149
+ tigris rm t3://my-bucket/file.txt -f
150
+ tigris rm t3://my-bucket/folder/ -rf
151
+ tigris rm t3://my-bucket -f
152
+ tigris rm "t3://my-bucket/logs/*.tmp" -f
139
153
  ```
140
154
 
141
155
  ## Authentication
142
156
 
143
157
  ### `login` | `l`
144
158
 
145
- Start a session. Use OAuth (default) or temporary credentials that override your saved config
159
+ Start a session via OAuth (default) or temporary credentials. Session state is cleared on logout
146
160
 
147
161
  | Command | Description |
148
162
  |---------|-------------|
149
163
  | `login select` | Choose how to login - OAuth (browser) or credentials (access key) |
150
- | `login oauth` (o) | Login via browser (OAuth2 device flow). Best for interactive use |
151
- | `login credentials` (c) | Login with access key + secret. Creates a temporary session (cleared on logout) |
164
+ | `login oauth` (o) | Login via browser using OAuth2 device flow. Best for interactive use |
165
+ | `login credentials` (c) | Login with an access key and secret. Creates a temporary session that is cleared on logout |
152
166
 
153
167
  #### `login select`
154
168
 
@@ -162,6 +176,11 @@ tigris login select
162
176
  tigris login oauth
163
177
  ```
164
178
 
179
+ **Examples:**
180
+ ```bash
181
+ tigris login oauth
182
+ ```
183
+
165
184
  #### `login credentials`
166
185
 
167
186
  ```
@@ -173,25 +192,41 @@ tigris login credentials [flags]
173
192
  | `-key, --access-key` | Your access key ID (will prompt if not provided) |
174
193
  | `-secret, --access-secret` | Your secret access key (will prompt if not provided) |
175
194
 
195
+ **Examples:**
196
+ ```bash
197
+ tigris login credentials --access-key tid_AaBb --access-secret tsec_XxYy
198
+ tigris login credentials
199
+ ```
200
+
176
201
  ### `logout`
177
202
 
178
- End your session. Clears login state but keeps credentials from 'configure'
203
+ End the current session and clear login state. Credentials saved via 'configure' are kept
179
204
 
180
205
  ```
181
206
  tigris logout
182
207
  ```
183
208
 
209
+ **Examples:**
210
+ ```bash
211
+ tigris logout
212
+ ```
213
+
184
214
  ### `whoami` | `w`
185
215
 
186
- Show information about the current user
216
+ Print the currently authenticated user, organization, and auth method
187
217
 
188
218
  ```
189
219
  tigris whoami
190
220
  ```
191
221
 
222
+ **Examples:**
223
+ ```bash
224
+ tigris whoami
225
+ ```
226
+
192
227
  ### `configure` | `c`
193
228
 
194
- Save credentials permanently. After running this, all commands work automatically
229
+ Save access-key credentials to ~/.tigris/config.json for persistent use across all commands
195
230
 
196
231
  ```
197
232
  tigris configure [flags]
@@ -203,17 +238,23 @@ tigris configure [flags]
203
238
  | `-secret, --access-secret` | Your Tigris secret access key |
204
239
  | `-e, --endpoint` | Tigris API endpoint (default: https://t3.storage.dev) |
205
240
 
241
+ **Examples:**
242
+ ```bash
243
+ tigris configure --access-key tid_AaBb --access-secret tsec_XxYy
244
+ tigris configure --endpoint https://custom.endpoint.dev
245
+ ```
246
+
206
247
  ## Resources
207
248
 
208
249
  ### `organizations` | `orgs`
209
250
 
210
- Manage organizations
251
+ List, create, and switch between organizations. An organization is a workspace that contains your resources like buckets and access keys
211
252
 
212
253
  | Command | Description |
213
254
  |---------|-------------|
214
- | `organizations list` (l) | List organizations |
215
- | `organizations create` (c) | Create organization |
216
- | `organizations select` (s) | Select the organization to use |
255
+ | `organizations list` (l) | List all organizations you belong to and interactively select one as active |
256
+ | `organizations create` (c) | Create a new organization with the given name |
257
+ | `organizations select` (s) | Set the named organization as your active org for all subsequent commands |
217
258
 
218
259
  #### `organizations list`
219
260
 
@@ -223,32 +264,48 @@ tigris organizations list [flags]
223
264
 
224
265
  | Flag | Description |
225
266
  |------|-------------|
226
- | `-f, --format` | Format (default: select) |
267
+ | `-f, --format` | Output format (default: select) |
227
268
  | `-i, --select` | Interactive selection mode |
228
269
 
270
+ **Examples:**
271
+ ```bash
272
+ tigris orgs list
273
+ tigris orgs list --format json
274
+ ```
275
+
229
276
  #### `organizations create`
230
277
 
231
278
  ```
232
279
  tigris organizations create <name>
233
280
  ```
234
281
 
282
+ **Examples:**
283
+ ```bash
284
+ tigris orgs create my-org
285
+ ```
286
+
235
287
  #### `organizations select`
236
288
 
237
289
  ```
238
290
  tigris organizations select <name>
239
291
  ```
240
292
 
293
+ **Examples:**
294
+ ```bash
295
+ tigris orgs select my-org
296
+ ```
297
+
241
298
  ### `access-keys` | `keys`
242
299
 
243
- Manage access keys
300
+ Create, list, inspect, delete, and assign roles to access keys. Access keys are credentials used for programmatic API access
244
301
 
245
302
  | Command | Description |
246
303
  |---------|-------------|
247
- | `access-keys list` (l) | List all access keys |
248
- | `access-keys create` (c) | Create a new access key |
249
- | `access-keys delete` (d) | Delete an access key |
250
- | `access-keys get` (g) | Get details of an access key |
251
- | `access-keys assign` (a) | Assign bucket roles to an access key |
304
+ | `access-keys list` (l) | List all access keys in the current organization |
305
+ | `access-keys create` (c) | Create a new access key with the given name. Returns the key ID and secret (shown only once) |
306
+ | `access-keys delete` (d) | Permanently delete an access key by its ID. This revokes all access immediately |
307
+ | `access-keys get` (g) | Show details for an access key including its name, creation date, and assigned bucket roles |
308
+ | `access-keys assign` (a) | Assign per-bucket roles to an access key. Pair each --bucket with a --role (Editor or ReadOnly), or use --admin for org-wide access |
252
309
 
253
310
  #### `access-keys list`
254
311
 
@@ -256,24 +313,44 @@ Manage access keys
256
313
  tigris access-keys list
257
314
  ```
258
315
 
316
+ **Examples:**
317
+ ```bash
318
+ tigris access-keys list
319
+ ```
320
+
259
321
  #### `access-keys create`
260
322
 
261
323
  ```
262
324
  tigris access-keys create <name>
263
325
  ```
264
326
 
327
+ **Examples:**
328
+ ```bash
329
+ tigris access-keys create my-ci-key
330
+ ```
331
+
265
332
  #### `access-keys delete`
266
333
 
267
334
  ```
268
335
  tigris access-keys delete <id>
269
336
  ```
270
337
 
338
+ **Examples:**
339
+ ```bash
340
+ tigris access-keys delete tid_AaBbCcDdEeFf
341
+ ```
342
+
271
343
  #### `access-keys get`
272
344
 
273
345
  ```
274
346
  tigris access-keys get <id>
275
347
  ```
276
348
 
349
+ **Examples:**
350
+ ```bash
351
+ tigris access-keys get tid_AaBbCcDdEeFf
352
+ ```
353
+
277
354
  #### `access-keys assign`
278
355
 
279
356
  ```
@@ -282,18 +359,26 @@ tigris access-keys assign <id> [flags]
282
359
 
283
360
  | Flag | Description |
284
361
  |------|-------------|
285
- | `-b, --bucket` | Bucket name (can specify multiple) |
286
- | `-r, --role` | Role to assign (can specify multiple to pair with buckets) |
362
+ | `-b, --bucket` | Bucket name (can specify multiple, comma-separated). Each bucket is paired positionally with a --role value |
363
+ | `-r, --role` | Role to assign (can specify multiple, comma-separated). Each role pairs with the corresponding --bucket value |
287
364
  | `--admin` | Grant admin access to all buckets in the organization |
288
365
  | `--revoke-roles` | Revoke all bucket roles from the access key |
289
366
 
367
+ **Examples:**
368
+ ```bash
369
+ tigris access-keys assign tid_AaBb --bucket my-bucket --role Editor
370
+ tigris access-keys assign tid_AaBb --bucket a,b --role Editor,ReadOnly
371
+ tigris access-keys assign tid_AaBb --admin
372
+ tigris access-keys assign tid_AaBb --revoke-roles
373
+ ```
374
+
290
375
  ### `credentials` | `creds`
291
376
 
292
- Manage and test credentials
377
+ Test whether your current credentials can reach Tigris and optionally verify access to a specific bucket
293
378
 
294
379
  | Command | Description |
295
380
  |---------|-------------|
296
- | `credentials test` (t) | Test if credentials have access to Tigris (optionally to a specific bucket) |
381
+ | `credentials test` (t) | Verify that current credentials are valid. Optionally checks access to a specific bucket |
297
382
 
298
383
  #### `credentials test`
299
384
 
@@ -305,21 +390,27 @@ tigris credentials test [flags]
305
390
  |------|-------------|
306
391
  | `-b, --bucket` | Bucket name to test access against (optional) |
307
392
 
393
+ **Examples:**
394
+ ```bash
395
+ tigris credentials test
396
+ tigris credentials test --bucket my-bucket
397
+ ```
398
+
308
399
  ### Buckets
309
400
 
310
401
  Buckets are containers for objects. You can also create forks and snapshots of buckets.
311
402
 
312
403
  #### `buckets` | `b`
313
404
 
314
- Manage buckets
405
+ Create, inspect, update, and delete buckets. Buckets are top-level containers that hold objects
315
406
 
316
407
  | Command | Description |
317
408
  |---------|-------------|
318
- | `buckets list` (l) | List buckets |
319
- | `buckets create` (c) | Create bucket |
320
- | `buckets get` (g) | Get bucket details |
321
- | `buckets delete` (d) | Delete bucket |
322
- | `buckets set` (s) | Update bucket settings |
409
+ | `buckets list` (l) | List all buckets in the current organization |
410
+ | `buckets create` (c) | Create a new bucket with optional access, tier, consistency, and region settings |
411
+ | `buckets get` (g) | Show details for a bucket including access level, region, tier, and custom domain |
412
+ | `buckets delete` (d) | Delete one or more buckets by name. The bucket must be empty or delete-protection must be off |
413
+ | `buckets set` (s) | Update settings on an existing bucket such as access level, region, caching, or custom domain |
323
414
 
324
415
  ##### `buckets list`
325
416
 
@@ -329,7 +420,13 @@ tigris buckets list [flags]
329
420
 
330
421
  | Flag | Description |
331
422
  |------|-------------|
332
- | `-f, --format` | Format (default: table) |
423
+ | `-f, --format` | Output format (default: table) |
424
+
425
+ **Examples:**
426
+ ```bash
427
+ tigris buckets list
428
+ tigris buckets list --format json
429
+ ```
333
430
 
334
431
  ##### `buckets create`
335
432
 
@@ -345,18 +442,36 @@ tigris buckets create [name] [flags]
345
442
  | `-c, --consistency` | Choose the consistency level for the bucket (default: default) |
346
443
  | `-r, --region` | Region (default: global) |
347
444
 
445
+ **Examples:**
446
+ ```bash
447
+ tigris buckets create my-bucket
448
+ tigris buckets create my-bucket --access public --region iad
449
+ tigris buckets create my-bucket --enable-snapshots --default-tier STANDARD_IA
450
+ ```
451
+
348
452
  ##### `buckets get`
349
453
 
350
454
  ```
351
455
  tigris buckets get <name>
352
456
  ```
353
457
 
458
+ **Examples:**
459
+ ```bash
460
+ tigris buckets get my-bucket
461
+ ```
462
+
354
463
  ##### `buckets delete`
355
464
 
356
465
  ```
357
466
  tigris buckets delete <name>
358
467
  ```
359
468
 
469
+ **Examples:**
470
+ ```bash
471
+ tigris buckets delete my-bucket
472
+ tigris buckets delete bucket-a,bucket-b
473
+ ```
474
+
360
475
  ##### `buckets set`
361
476
 
362
477
  ```
@@ -373,14 +488,21 @@ tigris buckets set <name> [flags]
373
488
  | `--custom-domain` | Custom domain for the bucket |
374
489
  | `--enable-delete-protection` | Enable delete protection |
375
490
 
491
+ **Examples:**
492
+ ```bash
493
+ tigris buckets set my-bucket --access public
494
+ tigris buckets set my-bucket --region iad,fra --cache-control 'max-age=3600'
495
+ tigris buckets set my-bucket --custom-domain assets.example.com
496
+ ```
497
+
376
498
  #### `forks` | `f`
377
499
 
378
- Manage forks
500
+ List and create forks. A fork is a writable copy-on-write clone of a bucket, useful for testing or branching data
379
501
 
380
502
  | Command | Description |
381
503
  |---------|-------------|
382
- | `forks list` (l) | List forks of a bucket |
383
- | `forks create` (c) | Create a fork of a bucket |
504
+ | `forks list` (l) | List all forks created from the given source bucket |
505
+ | `forks create` (c) | Create a new fork (copy-on-write clone) of the source bucket. Optionally fork from a specific snapshot |
384
506
 
385
507
  ##### `forks list`
386
508
 
@@ -392,6 +514,12 @@ tigris forks list <name> [flags]
392
514
  |------|-------------|
393
515
  | `-f, --format` | Output format (default: table) |
394
516
 
517
+ **Examples:**
518
+ ```bash
519
+ tigris forks list my-bucket
520
+ tigris forks list my-bucket --format json
521
+ ```
522
+
395
523
  ##### `forks create`
396
524
 
397
525
  ```
@@ -402,14 +530,20 @@ tigris forks create <name> <fork-name> [flags]
402
530
  |------|-------------|
403
531
  | `-s, --snapshot` | Create fork from a specific snapshot |
404
532
 
533
+ **Examples:**
534
+ ```bash
535
+ tigris forks create my-bucket my-fork
536
+ tigris forks create my-bucket my-fork --snapshot snap-2025-01-01
537
+ ```
538
+
405
539
  #### `snapshots` | `s`
406
540
 
407
- Manage snapshots
541
+ List and take snapshots. A snapshot is a point-in-time, read-only copy of a bucket's state
408
542
 
409
543
  | Command | Description |
410
544
  |---------|-------------|
411
- | `snapshots list` (l) | List snapshots of a bucket |
412
- | `snapshots take` (t) | Take a snapshot of a bucket |
545
+ | `snapshots list` (l) | List all snapshots for the given bucket, ordered by creation time |
546
+ | `snapshots take` (t) | Take a new snapshot of the bucket's current state. Optionally provide a name for the snapshot |
413
547
 
414
548
  ##### `snapshots list`
415
549
 
@@ -421,22 +555,34 @@ tigris snapshots list <name> [flags]
421
555
  |------|-------------|
422
556
  | `-f, --format` | Output format (default: table) |
423
557
 
558
+ **Examples:**
559
+ ```bash
560
+ tigris snapshots list my-bucket
561
+ tigris snapshots list my-bucket --format json
562
+ ```
563
+
424
564
  ##### `snapshots take`
425
565
 
426
566
  ```
427
567
  tigris snapshots take <name> [snapshot-name]
428
568
  ```
429
569
 
570
+ **Examples:**
571
+ ```bash
572
+ tigris snapshots take my-bucket
573
+ tigris snapshots take my-bucket my-snapshot
574
+ ```
575
+
430
576
  ### `objects` | `o`
431
577
 
432
- Manage objects
578
+ Low-level object operations for listing, downloading, uploading, and deleting individual objects in a bucket
433
579
 
434
580
  | Command | Description |
435
581
  |---------|-------------|
436
- | `objects list` (l) | List objects in a bucket |
437
- | `objects get` (g) | Get an object |
438
- | `objects put` (p) | Upload an object |
439
- | `objects delete` (d) | Delete an object |
582
+ | `objects list` (l) | List objects in a bucket, optionally filtered by a key prefix |
583
+ | `objects get` (g) | Download an object by key. Prints to stdout by default, or saves to a file with --output |
584
+ | `objects put` (p) | Upload a local file as an object. Content-type is auto-detected from extension unless overridden |
585
+ | `objects delete` (d) | Delete one or more objects by key from the given bucket |
440
586
 
441
587
  #### `objects list`
442
588
 
@@ -446,9 +592,16 @@ tigris objects list <bucket> [flags]
446
592
 
447
593
  | Flag | Description |
448
594
  |------|-------------|
449
- | `-p, --prefix` | Filter objects by prefix |
595
+ | `-p, --prefix` | Filter objects by key prefix (e.g. "images/" to list only images) |
450
596
  | `-f, --format` | Output format (default: table) |
451
597
 
598
+ **Examples:**
599
+ ```bash
600
+ tigris objects list my-bucket
601
+ tigris objects list my-bucket --prefix images/
602
+ tigris objects list my-bucket --format json
603
+ ```
604
+
452
605
  #### `objects get`
453
606
 
454
607
  ```
@@ -458,26 +611,44 @@ tigris objects get <bucket> <key> [flags]
458
611
  | Flag | Description |
459
612
  |------|-------------|
460
613
  | `-o, --output` | Output file path (if not specified, prints to stdout) |
461
- | `-m, --mode` | Response mode (auto-detected from extension if not specified) |
614
+ | `-m, --mode` | Response mode: "string" loads into memory, "stream" writes in chunks (auto-detected from extension if not specified) |
615
+
616
+ **Examples:**
617
+ ```bash
618
+ tigris objects get my-bucket config.json
619
+ tigris objects get my-bucket archive.zip --output ./archive.zip --mode stream
620
+ ```
462
621
 
463
622
  #### `objects put`
464
623
 
465
624
  ```
466
- tigris objects put <bucket> <key> <file> [flags]
625
+ tigris objects put <bucket> <key> [file] [flags]
467
626
  ```
468
627
 
469
628
  | Flag | Description |
470
629
  |------|-------------|
471
630
  | `-a, --access` | Access level (default: private) |
472
- | `-t, --content-type` | Content type |
631
+ | `-t, --content-type` | Content type (auto-detected from extension if omitted) |
473
632
  | `-f, --format` | Output format (default: table) |
474
633
 
634
+ **Examples:**
635
+ ```bash
636
+ tigris objects put my-bucket report.pdf ./report.pdf
637
+ tigris objects put my-bucket logo.png ./logo.png --access public --content-type image/png
638
+ ```
639
+
475
640
  #### `objects delete`
476
641
 
477
642
  ```
478
643
  tigris objects delete <bucket> <key>
479
644
  ```
480
645
 
646
+ **Examples:**
647
+ ```bash
648
+ tigris objects delete my-bucket old-file.txt
649
+ tigris objects delete my-bucket file-a.txt,file-b.txt
650
+ ```
651
+
481
652
  ## License
482
653
 
483
654
  MIT
@@ -1 +1 @@
1
- import{a,b}from"../chunk-WE6NZ2ZK.js";import"../chunk-NYAHHQ3A.js";import"../chunk-PKWQDQLT.js";import"../chunk-4BZ377KV.js";export{a as TigrisAuthClient,b as getAuthClient};
1
+ import{a,b}from"../chunk-DC3ZKGQV.js";import"../chunk-7F4WI32C.js";import"../chunk-UUITLEOI.js";import"../chunk-BP52O7NB.js";export{a as TigrisAuthClient,b as getAuthClient};
@@ -1 +1 @@
1
- import{a,b,c}from"../chunk-NYAHHQ3A.js";import"../chunk-4BZ377KV.js";export{b as TIGRIS_CLAIMS_NAMESPACE,a as getAuth0Config,c as getTigrisConfig};
1
+ import{a,b,c}from"../chunk-7F4WI32C.js";import"../chunk-BP52O7NB.js";export{b as TIGRIS_CLAIMS_NAMESPACE,a as getAuth0Config,c as getTigrisConfig};
@@ -1 +1 @@
1
- import{a,b,c,d}from"../chunk-TQWT7ROJ.js";import"../chunk-WE6NZ2ZK.js";import"../chunk-NYAHHQ3A.js";import"../chunk-PKWQDQLT.js";import"../chunk-4BZ377KV.js";export{a as getLoginMethod,c as getS3Client,b as getStorageConfig,d as isAuthenticated};
1
+ import{a,b,c,d}from"../chunk-PRJKBTQP.js";import"../chunk-DC3ZKGQV.js";import"../chunk-7F4WI32C.js";import"../chunk-UUITLEOI.js";import"../chunk-BP52O7NB.js";export{a as getLoginMethod,c as getS3Client,b as getStorageConfig,d as isAuthenticated};
@@ -1 +1 @@
1
- import{a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t}from"../chunk-PKWQDQLT.js";import"../chunk-4BZ377KV.js";export{t as clearAllData,q as clearCredentials,p as clearTemporaryCredentials,c as clearTokens,j as getAwsProfileConfig,k as getCredentials,h as getEnvCredentials,s as getLoginMethod,e as getOrganizations,m as getSavedCredentials,g as getSelectedOrganization,l as getStoredCredentials,b as getTokens,i as hasAwsProfile,n as storeCredentials,r as storeLoginMethod,d as storeOrganizations,f as storeSelectedOrganization,o as storeTemporaryCredentials,a as storeTokens};
1
+ import{a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t}from"../chunk-UUITLEOI.js";import"../chunk-BP52O7NB.js";export{t as clearAllData,q as clearCredentials,p as clearTemporaryCredentials,c as clearTokens,j as getAwsProfileConfig,k as getCredentials,h as getEnvCredentials,s as getLoginMethod,e as getOrganizations,m as getSavedCredentials,g as getSelectedOrganization,l as getStoredCredentials,b as getTokens,i as hasAwsProfile,n as storeCredentials,r as storeLoginMethod,d as storeOrganizations,f as storeSelectedOrganization,o as storeTemporaryCredentials,a as storeTokens};
@@ -1 +1 @@
1
- import{a as n,b as i}from"./chunk-4BZ377KV.js";function I(){let e=process.env.TIGRIS_ENV==="development",t=e?"auth-dev.tigris.dev":process.env.AUTH0_DOMAIN??"auth.tigris.dev",s=e?"JdJVYIyw0O1uHi5L5OJH903qaWBgd3gF":process.env.AUTH0_CLIENT_ID??"DMejqeM3CQ4IqTjEcd3oA9eEiT40hn8D",o=e?"https://tigris-api-dev":process.env.AUTH0_AUDIENCE??"https://tigris-os-api";return{domain:t,clientId:s,audience:o}}var p=process.env.TIGRIS_CLAIMS_NAMESPACE||"https://tigris";function T(){return process.env.TIGRIS_STORAGE_ENDPOINT||process.env.TIGRIS_IAM_ENDPOINT?{endpoint:process.env.TIGRIS_STORAGE_ENDPOINT||n,iamEndpoint:process.env.TIGRIS_IAM_ENDPOINT||i}:{endpoint:process.env.AWS_ENDPOINT_URL_S3||n,iamEndpoint:process.env.AWS_ENDPOINT_URL_IAM||i}}export{I as a,p as b,T as c};
1
+ import{a as n,b as i}from"./chunk-BP52O7NB.js";function I(){let e=process.env.TIGRIS_ENV==="development",t=e?"auth-dev.tigris.dev":process.env.AUTH0_DOMAIN??"auth.tigris.dev",s=e?"JdJVYIyw0O1uHi5L5OJH903qaWBgd3gF":process.env.AUTH0_CLIENT_ID??"DMejqeM3CQ4IqTjEcd3oA9eEiT40hn8D",o=e?"https://tigris-api-dev":process.env.AUTH0_AUDIENCE??"https://tigris-os-api";return{domain:t,clientId:s,audience:o}}var p=process.env.TIGRIS_CLAIMS_NAMESPACE||"https://tigris";function T(){return process.env.TIGRIS_STORAGE_ENDPOINT||process.env.TIGRIS_IAM_ENDPOINT?{endpoint:process.env.TIGRIS_STORAGE_ENDPOINT||n,iamEndpoint:process.env.TIGRIS_IAM_ENDPOINT||i}:{endpoint:process.env.AWS_ENDPOINT_URL_S3||n,iamEndpoint:process.env.AWS_ENDPOINT_URL_IAM||i}}export{I as a,p as b,T as c};
@@ -0,0 +1 @@
1
+ var t="https://t3.storage.dev",s="https://iam.storageapi.dev",o="https://registry.npmjs.org/@tigrisdata/cli/latest",_=864e5,e=216e5;export{t as a,s as b,o as c,_ as d,e};