@tigrisdata/cli 2.6.2 → 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.
- package/README.md +242 -80
- package/dist/auth/client.js +1 -1
- package/dist/auth/config.js +1 -1
- package/dist/auth/s3-client.js +1 -1
- package/dist/auth/storage.js +1 -1
- package/dist/{chunk-6U4U4JM6.js → chunk-7F4WI32C.js} +1 -1
- package/dist/chunk-BP52O7NB.js +1 -0
- package/dist/{chunk-QZXBLNMQ.js → chunk-DC3ZKGQV.js} +1 -1
- package/dist/chunk-EXTBL5CE.js +12 -0
- package/dist/{chunk-DJIPPZGR.js → chunk-HCOG24E2.js} +1 -1
- package/dist/chunk-NYQG3EX3.js +8 -0
- package/dist/chunk-PRJKBTQP.js +2 -0
- package/dist/{chunk-JVB3Y42V.js → chunk-UUITLEOI.js} +1 -1
- package/dist/{chunk-HE7E7ZMA.js → chunk-VT3KZHZZ.js} +1 -1
- package/dist/cli.js +1 -1
- package/dist/constants.js +1 -1
- package/dist/index.js +1 -1
- package/dist/lib/access-keys/assign.js +2 -2
- package/dist/lib/access-keys/create.js +2 -2
- package/dist/lib/access-keys/delete.js +2 -2
- package/dist/lib/access-keys/get.js +2 -2
- package/dist/lib/access-keys/list.js +2 -2
- package/dist/lib/buckets/create.js +1 -1
- package/dist/lib/buckets/delete.js +1 -1
- package/dist/lib/buckets/get.js +1 -1
- package/dist/lib/buckets/list.js +1 -1
- package/dist/lib/buckets/set.js +1 -1
- package/dist/lib/configure/index.js +1 -1
- package/dist/lib/cp.js +1 -1
- package/dist/lib/credentials/test.js +1 -1
- package/dist/lib/forks/create.js +1 -1
- package/dist/lib/forks/list.js +1 -1
- package/dist/lib/login/credentials.js +1 -1
- package/dist/lib/login/oauth.js +1 -1
- package/dist/lib/login/select.js +1 -1
- package/dist/lib/logout.js +1 -1
- package/dist/lib/ls.js +1 -1
- package/dist/lib/mk.js +1 -1
- package/dist/lib/mv.js +1 -1
- package/dist/lib/objects/delete.js +1 -1
- package/dist/lib/objects/get.js +1 -1
- package/dist/lib/objects/list.js +1 -1
- package/dist/lib/objects/put.js +1 -1
- package/dist/lib/organizations/create.js +2 -2
- package/dist/lib/organizations/list.js +2 -2
- package/dist/lib/organizations/select.js +3 -3
- package/dist/lib/rm.js +1 -1
- package/dist/lib/snapshots/list.js +1 -1
- package/dist/lib/snapshots/take.js +1 -1
- package/dist/lib/touch.js +1 -1
- package/dist/lib/whoami.js +1 -1
- package/dist/specs.yaml +210 -64
- package/dist/utils/update-check.js +1 -1
- package/package.json +3 -1
- package/postinstall.cjs +32 -0
- package/dist/chunk-D63SZLT5.js +0 -1
- package/dist/chunk-ESJWTUFN.js +0 -1
- package/dist/chunk-TPUZYSCZ.js +0 -12
- package/dist/chunk-TUJTXB5G.js +0 -8
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
|
|
22
|
-
- `tigris mk <path>` - Create a bucket or a folder
|
|
23
|
-
- `tigris touch <path>` - Create an empty object
|
|
24
|
-
- `tigris cp <src> <dest>` - Copy files between local filesystem and Tigris, or within Tigris
|
|
25
|
-
- `tigris mv <src> <dest>` - Move objects within Tigris
|
|
26
|
-
- `tigris rm <path>` - Remove a bucket, folder, or object from Tigris
|
|
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
|
|
31
|
-
- `tigris logout` - End
|
|
32
|
-
- `tigris whoami` -
|
|
33
|
-
- `tigris configure` - Save credentials
|
|
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` -
|
|
38
|
-
- `tigris access-keys` -
|
|
39
|
-
- `tigris credentials` -
|
|
40
|
-
- `tigris buckets` -
|
|
41
|
-
- `tigris forks` -
|
|
42
|
-
- `tigris snapshots` -
|
|
43
|
-
- `tigris 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
|
|
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,14 +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/
|
|
61
|
-
tigris ls t3://my-bucket
|
|
61
|
+
tigris ls my-bucket/images/
|
|
62
|
+
tigris ls t3://my-bucket/prefix/
|
|
62
63
|
```
|
|
63
64
|
|
|
64
65
|
### `mk` | `create`
|
|
65
66
|
|
|
66
|
-
Create a bucket or a folder
|
|
67
|
+
Create a bucket (bare name) or a folder inside a bucket (bucket/folder/ with trailing slash)
|
|
67
68
|
|
|
68
69
|
```
|
|
69
70
|
tigris mk <path>
|
|
@@ -72,13 +73,13 @@ tigris mk <path>
|
|
|
72
73
|
**Examples:**
|
|
73
74
|
```bash
|
|
74
75
|
tigris mk my-bucket
|
|
75
|
-
tigris mk my-bucket/
|
|
76
|
+
tigris mk my-bucket/images/
|
|
76
77
|
tigris mk t3://my-bucket
|
|
77
78
|
```
|
|
78
79
|
|
|
79
80
|
### `touch`
|
|
80
81
|
|
|
81
|
-
Create an empty object
|
|
82
|
+
Create an empty (zero-byte) object at the given bucket/key path
|
|
82
83
|
|
|
83
84
|
```
|
|
84
85
|
tigris touch <path>
|
|
@@ -86,13 +87,13 @@ tigris touch <path>
|
|
|
86
87
|
|
|
87
88
|
**Examples:**
|
|
88
89
|
```bash
|
|
89
|
-
tigris touch my-bucket/
|
|
90
|
-
tigris touch t3://my-bucket/
|
|
90
|
+
tigris touch my-bucket/placeholder.txt
|
|
91
|
+
tigris touch t3://my-bucket/logs/
|
|
91
92
|
```
|
|
92
93
|
|
|
93
94
|
### `cp` | `copy`
|
|
94
95
|
|
|
95
|
-
Copy files between local filesystem and Tigris, or within Tigris
|
|
96
|
+
Copy files between local filesystem and Tigris, or between paths within Tigris. At least one side must be a remote t3:// path
|
|
96
97
|
|
|
97
98
|
```
|
|
98
99
|
tigris cp <src> <dest> [flags]
|
|
@@ -100,17 +101,19 @@ tigris cp <src> <dest> [flags]
|
|
|
100
101
|
|
|
101
102
|
| Flag | Description |
|
|
102
103
|
|------|-------------|
|
|
103
|
-
| `-r, --recursive` |
|
|
104
|
+
| `-r, --recursive` | Copy directories recursively |
|
|
104
105
|
|
|
105
106
|
**Examples:**
|
|
106
107
|
```bash
|
|
107
|
-
tigris cp
|
|
108
|
-
tigris cp bucket/
|
|
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
|
|
109
112
|
```
|
|
110
113
|
|
|
111
114
|
### `mv` | `move`
|
|
112
115
|
|
|
113
|
-
Move objects within Tigris
|
|
116
|
+
Move (rename) objects within Tigris. Both source and destination must be remote t3:// paths
|
|
114
117
|
|
|
115
118
|
```
|
|
116
119
|
tigris mv <src> <dest> [flags]
|
|
@@ -118,18 +121,19 @@ tigris mv <src> <dest> [flags]
|
|
|
118
121
|
|
|
119
122
|
| Flag | Description |
|
|
120
123
|
|------|-------------|
|
|
121
|
-
| `-r, --recursive` |
|
|
124
|
+
| `-r, --recursive` | Move directories recursively |
|
|
122
125
|
| `-f, --force` | Skip confirmation prompt |
|
|
123
126
|
|
|
124
127
|
**Examples:**
|
|
125
128
|
```bash
|
|
126
|
-
tigris mv bucket/
|
|
127
|
-
tigris mv bucket/
|
|
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
|
|
128
132
|
```
|
|
129
133
|
|
|
130
134
|
### `rm` | `remove`
|
|
131
135
|
|
|
132
|
-
Remove a bucket, folder, or object from Tigris
|
|
136
|
+
Remove a bucket, folder, or object from Tigris. A bare bucket name deletes the bucket itself
|
|
133
137
|
|
|
134
138
|
```
|
|
135
139
|
tigris rm <path> [flags]
|
|
@@ -137,27 +141,28 @@ tigris rm <path> [flags]
|
|
|
137
141
|
|
|
138
142
|
| Flag | Description |
|
|
139
143
|
|------|-------------|
|
|
140
|
-
| `-r, --recursive` |
|
|
144
|
+
| `-r, --recursive` | Remove directories recursively |
|
|
141
145
|
| `-f, --force` | Skip confirmation prompt |
|
|
142
146
|
|
|
143
147
|
**Examples:**
|
|
144
148
|
```bash
|
|
145
|
-
tigris rm t3://my-bucket
|
|
146
|
-
tigris rm t3://my-bucket/
|
|
147
|
-
tigris rm t3://my-bucket
|
|
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
|
|
148
153
|
```
|
|
149
154
|
|
|
150
155
|
## Authentication
|
|
151
156
|
|
|
152
157
|
### `login` | `l`
|
|
153
158
|
|
|
154
|
-
Start a session
|
|
159
|
+
Start a session via OAuth (default) or temporary credentials. Session state is cleared on logout
|
|
155
160
|
|
|
156
161
|
| Command | Description |
|
|
157
162
|
|---------|-------------|
|
|
158
163
|
| `login select` | Choose how to login - OAuth (browser) or credentials (access key) |
|
|
159
|
-
| `login oauth` (o) | Login via browser
|
|
160
|
-
| `login credentials` (c) | Login with access key
|
|
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 |
|
|
161
166
|
|
|
162
167
|
#### `login select`
|
|
163
168
|
|
|
@@ -171,6 +176,11 @@ tigris login select
|
|
|
171
176
|
tigris login oauth
|
|
172
177
|
```
|
|
173
178
|
|
|
179
|
+
**Examples:**
|
|
180
|
+
```bash
|
|
181
|
+
tigris login oauth
|
|
182
|
+
```
|
|
183
|
+
|
|
174
184
|
#### `login credentials`
|
|
175
185
|
|
|
176
186
|
```
|
|
@@ -182,25 +192,41 @@ tigris login credentials [flags]
|
|
|
182
192
|
| `-key, --access-key` | Your access key ID (will prompt if not provided) |
|
|
183
193
|
| `-secret, --access-secret` | Your secret access key (will prompt if not provided) |
|
|
184
194
|
|
|
195
|
+
**Examples:**
|
|
196
|
+
```bash
|
|
197
|
+
tigris login credentials --access-key tid_AaBb --access-secret tsec_XxYy
|
|
198
|
+
tigris login credentials
|
|
199
|
+
```
|
|
200
|
+
|
|
185
201
|
### `logout`
|
|
186
202
|
|
|
187
|
-
End
|
|
203
|
+
End the current session and clear login state. Credentials saved via 'configure' are kept
|
|
188
204
|
|
|
189
205
|
```
|
|
190
206
|
tigris logout
|
|
191
207
|
```
|
|
192
208
|
|
|
209
|
+
**Examples:**
|
|
210
|
+
```bash
|
|
211
|
+
tigris logout
|
|
212
|
+
```
|
|
213
|
+
|
|
193
214
|
### `whoami` | `w`
|
|
194
215
|
|
|
195
|
-
|
|
216
|
+
Print the currently authenticated user, organization, and auth method
|
|
196
217
|
|
|
197
218
|
```
|
|
198
219
|
tigris whoami
|
|
199
220
|
```
|
|
200
221
|
|
|
222
|
+
**Examples:**
|
|
223
|
+
```bash
|
|
224
|
+
tigris whoami
|
|
225
|
+
```
|
|
226
|
+
|
|
201
227
|
### `configure` | `c`
|
|
202
228
|
|
|
203
|
-
Save credentials
|
|
229
|
+
Save access-key credentials to ~/.tigris/config.json for persistent use across all commands
|
|
204
230
|
|
|
205
231
|
```
|
|
206
232
|
tigris configure [flags]
|
|
@@ -212,17 +238,23 @@ tigris configure [flags]
|
|
|
212
238
|
| `-secret, --access-secret` | Your Tigris secret access key |
|
|
213
239
|
| `-e, --endpoint` | Tigris API endpoint (default: https://t3.storage.dev) |
|
|
214
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
|
+
|
|
215
247
|
## Resources
|
|
216
248
|
|
|
217
249
|
### `organizations` | `orgs`
|
|
218
250
|
|
|
219
|
-
|
|
251
|
+
List, create, and switch between organizations. An organization is a workspace that contains your resources like buckets and access keys
|
|
220
252
|
|
|
221
253
|
| Command | Description |
|
|
222
254
|
|---------|-------------|
|
|
223
|
-
| `organizations list` (l) | List organizations |
|
|
224
|
-
| `organizations create` (c) | Create organization |
|
|
225
|
-
| `organizations select` (s) |
|
|
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 |
|
|
226
258
|
|
|
227
259
|
#### `organizations list`
|
|
228
260
|
|
|
@@ -232,32 +264,48 @@ tigris organizations list [flags]
|
|
|
232
264
|
|
|
233
265
|
| Flag | Description |
|
|
234
266
|
|------|-------------|
|
|
235
|
-
| `-f, --format` |
|
|
267
|
+
| `-f, --format` | Output format (default: select) |
|
|
236
268
|
| `-i, --select` | Interactive selection mode |
|
|
237
269
|
|
|
270
|
+
**Examples:**
|
|
271
|
+
```bash
|
|
272
|
+
tigris orgs list
|
|
273
|
+
tigris orgs list --format json
|
|
274
|
+
```
|
|
275
|
+
|
|
238
276
|
#### `organizations create`
|
|
239
277
|
|
|
240
278
|
```
|
|
241
279
|
tigris organizations create <name>
|
|
242
280
|
```
|
|
243
281
|
|
|
282
|
+
**Examples:**
|
|
283
|
+
```bash
|
|
284
|
+
tigris orgs create my-org
|
|
285
|
+
```
|
|
286
|
+
|
|
244
287
|
#### `organizations select`
|
|
245
288
|
|
|
246
289
|
```
|
|
247
290
|
tigris organizations select <name>
|
|
248
291
|
```
|
|
249
292
|
|
|
293
|
+
**Examples:**
|
|
294
|
+
```bash
|
|
295
|
+
tigris orgs select my-org
|
|
296
|
+
```
|
|
297
|
+
|
|
250
298
|
### `access-keys` | `keys`
|
|
251
299
|
|
|
252
|
-
|
|
300
|
+
Create, list, inspect, delete, and assign roles to access keys. Access keys are credentials used for programmatic API access
|
|
253
301
|
|
|
254
302
|
| Command | Description |
|
|
255
303
|
|---------|-------------|
|
|
256
|
-
| `access-keys list` (l) | List all access keys |
|
|
257
|
-
| `access-keys create` (c) | Create a new access key |
|
|
258
|
-
| `access-keys delete` (d) |
|
|
259
|
-
| `access-keys get` (g) |
|
|
260
|
-
| `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 |
|
|
261
309
|
|
|
262
310
|
#### `access-keys list`
|
|
263
311
|
|
|
@@ -265,24 +313,44 @@ Manage access keys
|
|
|
265
313
|
tigris access-keys list
|
|
266
314
|
```
|
|
267
315
|
|
|
316
|
+
**Examples:**
|
|
317
|
+
```bash
|
|
318
|
+
tigris access-keys list
|
|
319
|
+
```
|
|
320
|
+
|
|
268
321
|
#### `access-keys create`
|
|
269
322
|
|
|
270
323
|
```
|
|
271
324
|
tigris access-keys create <name>
|
|
272
325
|
```
|
|
273
326
|
|
|
327
|
+
**Examples:**
|
|
328
|
+
```bash
|
|
329
|
+
tigris access-keys create my-ci-key
|
|
330
|
+
```
|
|
331
|
+
|
|
274
332
|
#### `access-keys delete`
|
|
275
333
|
|
|
276
334
|
```
|
|
277
335
|
tigris access-keys delete <id>
|
|
278
336
|
```
|
|
279
337
|
|
|
338
|
+
**Examples:**
|
|
339
|
+
```bash
|
|
340
|
+
tigris access-keys delete tid_AaBbCcDdEeFf
|
|
341
|
+
```
|
|
342
|
+
|
|
280
343
|
#### `access-keys get`
|
|
281
344
|
|
|
282
345
|
```
|
|
283
346
|
tigris access-keys get <id>
|
|
284
347
|
```
|
|
285
348
|
|
|
349
|
+
**Examples:**
|
|
350
|
+
```bash
|
|
351
|
+
tigris access-keys get tid_AaBbCcDdEeFf
|
|
352
|
+
```
|
|
353
|
+
|
|
286
354
|
#### `access-keys assign`
|
|
287
355
|
|
|
288
356
|
```
|
|
@@ -291,18 +359,26 @@ tigris access-keys assign <id> [flags]
|
|
|
291
359
|
|
|
292
360
|
| Flag | Description |
|
|
293
361
|
|------|-------------|
|
|
294
|
-
| `-b, --bucket` | Bucket name (can specify multiple) |
|
|
295
|
-
| `-r, --role` | Role to assign (can specify multiple
|
|
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 |
|
|
296
364
|
| `--admin` | Grant admin access to all buckets in the organization |
|
|
297
365
|
| `--revoke-roles` | Revoke all bucket roles from the access key |
|
|
298
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
|
+
|
|
299
375
|
### `credentials` | `creds`
|
|
300
376
|
|
|
301
|
-
|
|
377
|
+
Test whether your current credentials can reach Tigris and optionally verify access to a specific bucket
|
|
302
378
|
|
|
303
379
|
| Command | Description |
|
|
304
380
|
|---------|-------------|
|
|
305
|
-
| `credentials test` (t) |
|
|
381
|
+
| `credentials test` (t) | Verify that current credentials are valid. Optionally checks access to a specific bucket |
|
|
306
382
|
|
|
307
383
|
#### `credentials test`
|
|
308
384
|
|
|
@@ -314,21 +390,27 @@ tigris credentials test [flags]
|
|
|
314
390
|
|------|-------------|
|
|
315
391
|
| `-b, --bucket` | Bucket name to test access against (optional) |
|
|
316
392
|
|
|
393
|
+
**Examples:**
|
|
394
|
+
```bash
|
|
395
|
+
tigris credentials test
|
|
396
|
+
tigris credentials test --bucket my-bucket
|
|
397
|
+
```
|
|
398
|
+
|
|
317
399
|
### Buckets
|
|
318
400
|
|
|
319
401
|
Buckets are containers for objects. You can also create forks and snapshots of buckets.
|
|
320
402
|
|
|
321
403
|
#### `buckets` | `b`
|
|
322
404
|
|
|
323
|
-
|
|
405
|
+
Create, inspect, update, and delete buckets. Buckets are top-level containers that hold objects
|
|
324
406
|
|
|
325
407
|
| Command | Description |
|
|
326
408
|
|---------|-------------|
|
|
327
|
-
| `buckets list` (l) | List buckets |
|
|
328
|
-
| `buckets create` (c) | Create bucket |
|
|
329
|
-
| `buckets get` (g) |
|
|
330
|
-
| `buckets delete` (d) | Delete bucket |
|
|
331
|
-
| `buckets set` (s) | Update bucket
|
|
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 |
|
|
332
414
|
|
|
333
415
|
##### `buckets list`
|
|
334
416
|
|
|
@@ -338,7 +420,13 @@ tigris buckets list [flags]
|
|
|
338
420
|
|
|
339
421
|
| Flag | Description |
|
|
340
422
|
|------|-------------|
|
|
341
|
-
| `-f, --format` |
|
|
423
|
+
| `-f, --format` | Output format (default: table) |
|
|
424
|
+
|
|
425
|
+
**Examples:**
|
|
426
|
+
```bash
|
|
427
|
+
tigris buckets list
|
|
428
|
+
tigris buckets list --format json
|
|
429
|
+
```
|
|
342
430
|
|
|
343
431
|
##### `buckets create`
|
|
344
432
|
|
|
@@ -354,18 +442,36 @@ tigris buckets create [name] [flags]
|
|
|
354
442
|
| `-c, --consistency` | Choose the consistency level for the bucket (default: default) |
|
|
355
443
|
| `-r, --region` | Region (default: global) |
|
|
356
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
|
+
|
|
357
452
|
##### `buckets get`
|
|
358
453
|
|
|
359
454
|
```
|
|
360
455
|
tigris buckets get <name>
|
|
361
456
|
```
|
|
362
457
|
|
|
458
|
+
**Examples:**
|
|
459
|
+
```bash
|
|
460
|
+
tigris buckets get my-bucket
|
|
461
|
+
```
|
|
462
|
+
|
|
363
463
|
##### `buckets delete`
|
|
364
464
|
|
|
365
465
|
```
|
|
366
466
|
tigris buckets delete <name>
|
|
367
467
|
```
|
|
368
468
|
|
|
469
|
+
**Examples:**
|
|
470
|
+
```bash
|
|
471
|
+
tigris buckets delete my-bucket
|
|
472
|
+
tigris buckets delete bucket-a,bucket-b
|
|
473
|
+
```
|
|
474
|
+
|
|
369
475
|
##### `buckets set`
|
|
370
476
|
|
|
371
477
|
```
|
|
@@ -382,14 +488,21 @@ tigris buckets set <name> [flags]
|
|
|
382
488
|
| `--custom-domain` | Custom domain for the bucket |
|
|
383
489
|
| `--enable-delete-protection` | Enable delete protection |
|
|
384
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
|
+
|
|
385
498
|
#### `forks` | `f`
|
|
386
499
|
|
|
387
|
-
|
|
500
|
+
List and create forks. A fork is a writable copy-on-write clone of a bucket, useful for testing or branching data
|
|
388
501
|
|
|
389
502
|
| Command | Description |
|
|
390
503
|
|---------|-------------|
|
|
391
|
-
| `forks list` (l) | List forks
|
|
392
|
-
| `forks create` (c) | Create a fork of
|
|
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 |
|
|
393
506
|
|
|
394
507
|
##### `forks list`
|
|
395
508
|
|
|
@@ -401,6 +514,12 @@ tigris forks list <name> [flags]
|
|
|
401
514
|
|------|-------------|
|
|
402
515
|
| `-f, --format` | Output format (default: table) |
|
|
403
516
|
|
|
517
|
+
**Examples:**
|
|
518
|
+
```bash
|
|
519
|
+
tigris forks list my-bucket
|
|
520
|
+
tigris forks list my-bucket --format json
|
|
521
|
+
```
|
|
522
|
+
|
|
404
523
|
##### `forks create`
|
|
405
524
|
|
|
406
525
|
```
|
|
@@ -411,14 +530,20 @@ tigris forks create <name> <fork-name> [flags]
|
|
|
411
530
|
|------|-------------|
|
|
412
531
|
| `-s, --snapshot` | Create fork from a specific snapshot |
|
|
413
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
|
+
|
|
414
539
|
#### `snapshots` | `s`
|
|
415
540
|
|
|
416
|
-
|
|
541
|
+
List and take snapshots. A snapshot is a point-in-time, read-only copy of a bucket's state
|
|
417
542
|
|
|
418
543
|
| Command | Description |
|
|
419
544
|
|---------|-------------|
|
|
420
|
-
| `snapshots list` (l) | List snapshots
|
|
421
|
-
| `snapshots take` (t) | Take a snapshot of
|
|
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 |
|
|
422
547
|
|
|
423
548
|
##### `snapshots list`
|
|
424
549
|
|
|
@@ -430,22 +555,34 @@ tigris snapshots list <name> [flags]
|
|
|
430
555
|
|------|-------------|
|
|
431
556
|
| `-f, --format` | Output format (default: table) |
|
|
432
557
|
|
|
558
|
+
**Examples:**
|
|
559
|
+
```bash
|
|
560
|
+
tigris snapshots list my-bucket
|
|
561
|
+
tigris snapshots list my-bucket --format json
|
|
562
|
+
```
|
|
563
|
+
|
|
433
564
|
##### `snapshots take`
|
|
434
565
|
|
|
435
566
|
```
|
|
436
567
|
tigris snapshots take <name> [snapshot-name]
|
|
437
568
|
```
|
|
438
569
|
|
|
570
|
+
**Examples:**
|
|
571
|
+
```bash
|
|
572
|
+
tigris snapshots take my-bucket
|
|
573
|
+
tigris snapshots take my-bucket my-snapshot
|
|
574
|
+
```
|
|
575
|
+
|
|
439
576
|
### `objects` | `o`
|
|
440
577
|
|
|
441
|
-
|
|
578
|
+
Low-level object operations for listing, downloading, uploading, and deleting individual objects in a bucket
|
|
442
579
|
|
|
443
580
|
| Command | Description |
|
|
444
581
|
|---------|-------------|
|
|
445
|
-
| `objects list` (l) | List objects in a bucket |
|
|
446
|
-
| `objects get` (g) |
|
|
447
|
-
| `objects put` (p) | Upload an object |
|
|
448
|
-
| `objects delete` (d) | Delete
|
|
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 |
|
|
449
586
|
|
|
450
587
|
#### `objects list`
|
|
451
588
|
|
|
@@ -455,9 +592,16 @@ tigris objects list <bucket> [flags]
|
|
|
455
592
|
|
|
456
593
|
| Flag | Description |
|
|
457
594
|
|------|-------------|
|
|
458
|
-
| `-p, --prefix` | Filter objects by prefix |
|
|
595
|
+
| `-p, --prefix` | Filter objects by key prefix (e.g. "images/" to list only images) |
|
|
459
596
|
| `-f, --format` | Output format (default: table) |
|
|
460
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
|
+
|
|
461
605
|
#### `objects get`
|
|
462
606
|
|
|
463
607
|
```
|
|
@@ -467,7 +611,13 @@ tigris objects get <bucket> <key> [flags]
|
|
|
467
611
|
| Flag | Description |
|
|
468
612
|
|------|-------------|
|
|
469
613
|
| `-o, --output` | Output file path (if not specified, prints to stdout) |
|
|
470
|
-
| `-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
|
+
```
|
|
471
621
|
|
|
472
622
|
#### `objects put`
|
|
473
623
|
|
|
@@ -478,15 +628,27 @@ tigris objects put <bucket> <key> [file] [flags]
|
|
|
478
628
|
| Flag | Description |
|
|
479
629
|
|------|-------------|
|
|
480
630
|
| `-a, --access` | Access level (default: private) |
|
|
481
|
-
| `-t, --content-type` | Content type |
|
|
631
|
+
| `-t, --content-type` | Content type (auto-detected from extension if omitted) |
|
|
482
632
|
| `-f, --format` | Output format (default: table) |
|
|
483
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
|
+
|
|
484
640
|
#### `objects delete`
|
|
485
641
|
|
|
486
642
|
```
|
|
487
643
|
tigris objects delete <bucket> <key>
|
|
488
644
|
```
|
|
489
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
|
+
|
|
490
652
|
## License
|
|
491
653
|
|
|
492
654
|
MIT
|
package/dist/auth/client.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
import{a,b}from"../chunk-
|
|
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};
|
package/dist/auth/config.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
import{a,b,c}from"../chunk-
|
|
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};
|
package/dist/auth/s3-client.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
import{a,b,c,d}from"../chunk-
|
|
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};
|
package/dist/auth/storage.js
CHANGED
|
@@ -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-
|
|
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-
|
|
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};
|