@tigrisdata/cli 3.17.1 → 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.
- package/README.md +573 -459
- package/SKILL.md +1 -1
- package/dist/auth/iam.js +1 -1
- package/dist/auth/provider.js +1 -1
- package/dist/browser/index.d.ts +2 -1
- package/dist/browser/index.js +488 -464
- package/dist/{chunk-M4JVQTPR.js → chunk-33VTJA5G.js} +1 -1
- package/dist/chunk-36RAXRXY.js +1 -0
- package/dist/chunk-55YC7L3R.js +8 -0
- package/dist/{chunk-PMFE4543.js → chunk-5R42YPIF.js} +1 -1
- package/dist/{chunk-EBZOJ2UO.js → chunk-BQPKRG5X.js} +1 -1
- package/dist/{chunk-EYLDWSKA.js → chunk-E52D2O5C.js} +1 -1
- package/dist/{chunk-OUSR4REZ.js → chunk-GREORRSJ.js} +1 -1
- package/dist/{chunk-RUJKMQPD.js → chunk-NEHPRANM.js} +1 -1
- package/dist/{chunk-VFFI5OXM.js → chunk-OK2INJKO.js} +1 -1
- package/dist/chunk-PYPHHAPF.js +4 -0
- package/dist/chunk-Q24ZEHJN.js +1 -0
- package/dist/chunk-QOOQVR7J.js +1 -0
- package/dist/chunk-SFXAZO6M.js +1 -0
- package/dist/{chunk-APVIWSSE.js → chunk-STUJSAPH.js} +1 -1
- package/dist/{chunk-MZ6PKN6C.js → chunk-TBJQJJ45.js} +1 -1
- package/dist/{chunk-H5EV2OLS.js → chunk-TBX42XAN.js} +1 -1
- package/dist/cli-core.js +3 -1
- package/dist/cli.js +1 -1
- package/dist/index.js +1 -1
- package/dist/lib/access-keys/assign.js +1 -1
- package/dist/lib/access-keys/attach-policy.js +1 -1
- package/dist/lib/access-keys/create.js +1 -1
- package/dist/lib/access-keys/default-permissions.js +1 -1
- package/dist/lib/access-keys/delete.js +1 -1
- package/dist/lib/access-keys/detach-policy.js +1 -1
- package/dist/lib/access-keys/get.js +1 -1
- package/dist/lib/access-keys/list-policies.js +1 -1
- package/dist/lib/access-keys/list.js +1 -1
- package/dist/lib/access-keys/roles.js +1 -1
- package/dist/lib/access-keys/rotate.js +1 -1
- package/dist/lib/access-keys/set.js +1 -1
- package/dist/lib/buckets/create.js +1 -1
- package/dist/lib/buckets/delete.js +1 -1
- package/dist/lib/buckets/disable-snapshots.js +1 -1
- package/dist/lib/buckets/enable-snapshots.js +1 -1
- package/dist/lib/buckets/get.js +1 -1
- package/dist/lib/buckets/lifecycle/create.js +1 -1
- package/dist/lib/buckets/lifecycle/edit.js +1 -1
- package/dist/lib/buckets/lifecycle/list.js +1 -1
- package/dist/lib/buckets/lifecycle/shared.js +1 -1
- package/dist/lib/buckets/list.js +1 -1
- package/dist/lib/buckets/merge.js +1 -1
- package/dist/lib/buckets/migrate.js +5 -5
- package/dist/lib/buckets/purge.js +1 -1
- package/dist/lib/buckets/rebase.js +1 -1
- package/dist/lib/buckets/restore.js +1 -1
- package/dist/lib/buckets/set-cors.js +1 -1
- package/dist/lib/buckets/set-locations.js +1 -1
- package/dist/lib/buckets/set-migration.js +1 -1
- package/dist/lib/buckets/set-notifications.js +1 -1
- package/dist/lib/buckets/set.js +1 -1
- package/dist/lib/buckets/share.js +1 -1
- package/dist/lib/bundle.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/iam/policies/create.js +1 -1
- package/dist/lib/iam/policies/delete.js +1 -1
- package/dist/lib/iam/policies/edit.js +1 -1
- package/dist/lib/iam/policies/get.js +1 -1
- package/dist/lib/iam/policies/link-key.js +1 -1
- package/dist/lib/iam/policies/list-keys.js +1 -1
- package/dist/lib/iam/policies/list.js +1 -1
- package/dist/lib/iam/policies/select-policy.js +1 -1
- package/dist/lib/iam/policies/unlink-key.js +1 -1
- package/dist/lib/iam/teams/create.js +1 -1
- package/dist/lib/iam/teams/edit.js +1 -1
- package/dist/lib/iam/teams/list.js +1 -1
- package/dist/lib/iam/teams/shared.js +1 -1
- package/dist/lib/iam/users/invite.js +1 -1
- package/dist/lib/iam/users/list.js +1 -1
- package/dist/lib/iam/users/remove.js +1 -1
- package/dist/lib/iam/users/revoke-invitation.js +1 -1
- package/dist/lib/iam/users/update-role.js +1 -1
- package/dist/lib/init/index.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/info.js +1 -1
- package/dist/lib/objects/list-versions.js +1 -1
- package/dist/lib/objects/list.js +1 -1
- package/dist/lib/objects/purge.js +1 -1
- package/dist/lib/objects/put.js +1 -1
- package/dist/lib/objects/restore-deleted.js +1 -1
- package/dist/lib/objects/restore-info.js +1 -1
- package/dist/lib/objects/restore.js +1 -1
- package/dist/lib/objects/set-access.js +1 -1
- package/dist/lib/objects/set.js +1 -1
- package/dist/lib/organizations/create.js +1 -1
- package/dist/lib/organizations/delete.js +1 -1
- package/dist/lib/organizations/list.js +1 -1
- package/dist/lib/organizations/select.js +1 -1
- package/dist/lib/presign.js +1 -1
- package/dist/lib/rm.js +1 -1
- package/dist/lib/snapshots/delete.js +1 -1
- package/dist/lib/snapshots/list.js +1 -1
- package/dist/lib/snapshots/take.js +1 -1
- package/dist/lib/stat.js +1 -1
- package/dist/lib/telemetry/disable.js +1 -1
- package/dist/lib/telemetry/enable.js +1 -1
- package/dist/lib/telemetry/status.js +2 -2
- package/dist/lib/touch.js +1 -1
- package/dist/lib/update.js +1 -1
- package/dist/lib/usage.js +1 -1
- package/dist/lib/whoami.js +1 -1
- package/dist/specs.yaml +323 -299
- package/dist/utils/analytics.js +1 -1
- package/dist/utils/bucket-info.js +1 -1
- package/dist/utils/exit.js +1 -1
- package/dist/utils/telemetry-sender.js +1 -0
- package/dist/utils/telemetry.js +1 -1
- package/dist/utils/update-check.js +1 -1
- package/package.json +2 -2
- package/dist/chunk-27XCIHXN.js +0 -1
- package/dist/chunk-IAAJ66FY.js +0 -1
- package/dist/chunk-P76USEKI.js +0 -4
- package/dist/chunk-UURDKGI7.js +0 -3
- package/dist/chunk-WJWKFYJJ.js +0 -1
- package/dist/chunk-YEO7OHQF.js +0 -7
- /package/dist/{chunk-HQ4JNO3D.js → chunk-ILMD5XON.js} +0 -0
package/README.md
CHANGED
|
@@ -33,32 +33,32 @@ Run `tigris help` to see all available commands, or `tigris <command> help` for
|
|
|
33
33
|
|
|
34
34
|
### Commands
|
|
35
35
|
|
|
36
|
-
| Command
|
|
37
|
-
|
|
38
|
-
| `tigris init` (start)
|
|
39
|
-
| `tigris configure` (c)
|
|
40
|
-
| `tigris login` (l)
|
|
41
|
-
| `tigris whoami` (w)
|
|
42
|
-
| `tigris usage`
|
|
43
|
-
| `tigris update`
|
|
44
|
-
| `tigris logout`
|
|
45
|
-
| `tigris credentials` (creds)
|
|
46
|
-
| `tigris telemetry`
|
|
47
|
-
| `tigris ls` (list)
|
|
48
|
-
| `tigris mk` (create)
|
|
49
|
-
| `tigris touch`
|
|
50
|
-
| `tigris stat`
|
|
51
|
-
| `tigris presign`
|
|
52
|
-
| `tigris cp` (copy)
|
|
53
|
-
| `tigris mv` (move)
|
|
54
|
-
| `tigris rm` (remove)
|
|
55
|
-
| `tigris bundle`
|
|
56
|
-
| `tigris organizations` (orgs) | List, create, and switch between organizations. An organization is a workspace that contains your resources like buckets and access keys
|
|
57
|
-
| `tigris buckets` (b)
|
|
58
|
-
| `tigris snapshots` (s)
|
|
59
|
-
| `tigris objects` (o)
|
|
60
|
-
| `tigris access-keys` (keys)
|
|
61
|
-
| `tigris iam`
|
|
36
|
+
| Command | Description |
|
|
37
|
+
| ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
38
|
+
| `tigris init` (start) | Connect Tigris to your AI coding agent — MCP server config and agent skills |
|
|
39
|
+
| `tigris configure` (c) | Save access-key credentials to ~/.tigris/config.json for persistent use across all commands |
|
|
40
|
+
| `tigris login` (l) | Start a session via OAuth (default) or temporary credentials. Session state is cleared on logout |
|
|
41
|
+
| `tigris whoami` (w) | Print the currently authenticated user, organization, and auth method |
|
|
42
|
+
| `tigris usage` | Show the active organization's usage and charges for a billing month, as on the console's Usage page. Requires OAuth login |
|
|
43
|
+
| `tigris update` | Update the CLI to the latest version |
|
|
44
|
+
| `tigris logout` | End the current session and clear login state. Credentials saved via 'configure' are kept |
|
|
45
|
+
| `tigris credentials` (creds) | Test whether your current credentials can reach Tigris and optionally verify access to a specific bucket |
|
|
46
|
+
| `tigris telemetry` | Show or change whether the CLI sends usage analytics and error reports |
|
|
47
|
+
| `tigris ls` (list) | List all buckets (no arguments) or objects under a bucket/prefix path. Accepts bare names or t3:// URIs |
|
|
48
|
+
| `tigris mk` (create) | Create a bucket (bare name) or a folder inside a bucket (bucket/folder/ with trailing slash) |
|
|
49
|
+
| `tigris touch` | Create an empty (zero-byte) object at the given bucket/key path |
|
|
50
|
+
| `tigris stat` | Show storage stats (no args), bucket info, or object metadata |
|
|
51
|
+
| `tigris presign` | Generate a presigned URL for temporary access to an object without credentials |
|
|
52
|
+
| `tigris cp` (copy) | Copy files between local filesystem and Tigris, or between paths within Tigris. At least one side must be a remote t3:// path |
|
|
53
|
+
| `tigris mv` (move) | Move (rename) objects within Tigris. Both source and destination must be remote t3:// paths |
|
|
54
|
+
| `tigris rm` (remove) | Remove a bucket, folder, or object from Tigris. A bare bucket name deletes the bucket itself |
|
|
55
|
+
| `tigris bundle` | Download multiple objects as a streaming tar archive in a single request. Designed for batch workloads that need many objects without per-object HTTP overhead |
|
|
56
|
+
| `tigris organizations` (orgs) | List, create, and switch between organizations. An organization is a workspace that contains your resources like buckets and access keys |
|
|
57
|
+
| `tigris buckets` (b) | Create, inspect, update, and delete buckets. Buckets are top-level containers that hold objects |
|
|
58
|
+
| `tigris snapshots` (s) | List, take, and delete snapshots. A snapshot is a point-in-time, read-only copy of a bucket's state |
|
|
59
|
+
| `tigris objects` (o) | Low-level object operations for listing, downloading, uploading, and deleting individual objects in a bucket |
|
|
60
|
+
| `tigris access-keys` (keys) | Create, list, inspect, delete, and assign roles to access keys. Access keys are credentials used for programmatic API access |
|
|
61
|
+
| `tigris iam` | Identity and Access Management - manage policies, users, and permissions |
|
|
62
62
|
|
|
63
63
|
---
|
|
64
64
|
|
|
@@ -70,11 +70,12 @@ Connect Tigris to your AI coding agent — MCP server config and agent skills
|
|
|
70
70
|
tigris init [flags]
|
|
71
71
|
```
|
|
72
72
|
|
|
73
|
-
| Flag
|
|
74
|
-
|
|
73
|
+
| Flag | Description |
|
|
74
|
+
| --------- | ----------------------------------------------------------------------------------------------- |
|
|
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
|
|
@@ -89,13 +90,14 @@ Save access-key credentials to ~/.tigris/config.json for persistent use across a
|
|
|
89
90
|
tigris configure [flags]
|
|
90
91
|
```
|
|
91
92
|
|
|
92
|
-
| Flag
|
|
93
|
-
|
|
94
|
-
| `-key, --access-key`
|
|
95
|
-
| `-secret, --access-secret` | Your Tigris secret access key
|
|
96
|
-
| `-e, --endpoint`
|
|
93
|
+
| Flag | Description |
|
|
94
|
+
| -------------------------- | ----------------------------------------------------- |
|
|
95
|
+
| `-key, --access-key` | Your Tigris access key ID |
|
|
96
|
+
| `-secret, --access-secret` | Your Tigris secret access key |
|
|
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
|
|
@@ -105,10 +107,10 @@ tigris configure --endpoint https://custom.endpoint.dev
|
|
|
105
107
|
|
|
106
108
|
Start a session via OAuth (default) or temporary credentials. Session state is cleared on logout
|
|
107
109
|
|
|
108
|
-
| Command
|
|
109
|
-
|
|
110
|
-
| `tigris login select`
|
|
111
|
-
| `tigris login oauth` (o)
|
|
110
|
+
| Command | Description |
|
|
111
|
+
| ------------------------------ | ------------------------------------------------------------------------------------------ |
|
|
112
|
+
| `tigris login select` | Choose how to login - OAuth (browser) or credentials (access key) |
|
|
113
|
+
| `tigris login oauth` (o) | Login via browser using OAuth2 device flow. Best for interactive use |
|
|
112
114
|
| `tigris login credentials` (c) | Login with an access key and secret. Creates a temporary session that is cleared on logout |
|
|
113
115
|
|
|
114
116
|
#### `tigris login select`
|
|
@@ -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
|
```
|
|
@@ -140,12 +143,13 @@ Login with an access key and secret. Creates a temporary session that is cleared
|
|
|
140
143
|
tigris login credentials [flags]
|
|
141
144
|
```
|
|
142
145
|
|
|
143
|
-
| Flag
|
|
144
|
-
|
|
145
|
-
| `-key, --access-key`
|
|
146
|
+
| Flag | Description |
|
|
147
|
+
| -------------------------- | ---------------------------------------------------- |
|
|
148
|
+
| `-key, --access-key` | Your access key ID (will prompt if not provided) |
|
|
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
|
```
|
|
@@ -172,13 +177,14 @@ Show the active organization's usage and charges for a billing month, as on the
|
|
|
172
177
|
tigris usage [flags]
|
|
173
178
|
```
|
|
174
179
|
|
|
175
|
-
| Flag
|
|
176
|
-
|
|
177
|
-
| `--month`
|
|
178
|
-
| `--all`
|
|
179
|
-
| `--format` | Output format (default: table)
|
|
180
|
+
| Flag | Description |
|
|
181
|
+
| ---------- | ------------------------------------------------------- |
|
|
182
|
+
| `--month` | Billing month as YYYY-MM (default is the current month) |
|
|
183
|
+
| `--all` | Show every line item, even those with zero usage |
|
|
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
|
```
|
|
@@ -216,8 +224,8 @@ tigris logout
|
|
|
216
224
|
|
|
217
225
|
Test whether your current credentials can reach Tigris and optionally verify access to a specific bucket
|
|
218
226
|
|
|
219
|
-
| Command
|
|
220
|
-
|
|
227
|
+
| Command | Description |
|
|
228
|
+
| ----------------------------- | ---------------------------------------------------------------------------------------- |
|
|
221
229
|
| `tigris credentials test` (t) | Verify that current credentials are valid. Optionally checks access to a specific bucket |
|
|
222
230
|
|
|
223
231
|
#### `tigris credentials test` (t)
|
|
@@ -228,11 +236,12 @@ Verify that current credentials are valid. Optionally checks access to a specifi
|
|
|
228
236
|
tigris credentials test [flags]
|
|
229
237
|
```
|
|
230
238
|
|
|
231
|
-
| Flag
|
|
232
|
-
|
|
239
|
+
| Flag | Description |
|
|
240
|
+
| -------------- | --------------------------------------------- |
|
|
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
|
|
@@ -242,11 +251,11 @@ tigris credentials test --bucket my-bucket
|
|
|
242
251
|
|
|
243
252
|
Show or change whether the CLI sends usage analytics and error reports
|
|
244
253
|
|
|
245
|
-
| Command
|
|
246
|
-
|
|
247
|
-
| `tigris telemetry status`
|
|
248
|
-
| `tigris telemetry disable` | Turn off usage analytics and error reports on this machine
|
|
249
|
-
| `tigris telemetry enable`
|
|
254
|
+
| Command | Description |
|
|
255
|
+
| -------------------------- | ------------------------------------------------------------------------------------ |
|
|
256
|
+
| `tigris telemetry status` | Show whether telemetry is enabled, what is collected, and which setting is in effect |
|
|
257
|
+
| `tigris telemetry disable` | Turn off usage analytics and error reports on this machine |
|
|
258
|
+
| `tigris telemetry enable` | Turn usage analytics and error reports back on for this machine |
|
|
250
259
|
|
|
251
260
|
#### `tigris telemetry status`
|
|
252
261
|
|
|
@@ -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
|
```
|
|
@@ -295,15 +307,16 @@ List all buckets (no arguments) or objects under a bucket/prefix path. Accepts b
|
|
|
295
307
|
tigris ls [path] [flags]
|
|
296
308
|
```
|
|
297
309
|
|
|
298
|
-
| Flag
|
|
299
|
-
|
|
310
|
+
| Flag | Description |
|
|
311
|
+
| ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
300
312
|
| `-snapshot, --snapshot-version` | Read from a specific bucket snapshot. Accepts a snapshot version string or any UNIX nanosecond-precision timestamp (e.g. 1765889000501544464) |
|
|
301
|
-
| `--format`
|
|
302
|
-
| `--limit`
|
|
303
|
-
| `-pt, --page-token`
|
|
304
|
-
| `--source`
|
|
313
|
+
| `--format` | Output format (default: table) |
|
|
314
|
+
| `--limit` | Maximum number of items to return per page |
|
|
315
|
+
| `-pt, --page-token` | Pagination token from a previous request to fetch the next page |
|
|
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
|
|
@@ -319,19 +332,21 @@ Create a bucket (bare name) or a folder inside a bucket (bucket/folder/ with tra
|
|
|
319
332
|
tigris mk <path> [flags]
|
|
320
333
|
```
|
|
321
334
|
|
|
322
|
-
| Flag
|
|
323
|
-
|
|
324
|
-
| `-a, --access`
|
|
325
|
-
| `--public`
|
|
326
|
-
| `-s, --enable-snapshots`
|
|
327
|
-
| `--allow-object-acl`
|
|
328
|
-
| `--enable-directory-listing`
|
|
329
|
-
|
|
|
330
|
-
| `-
|
|
331
|
-
| `-
|
|
335
|
+
| Flag | Description |
|
|
336
|
+
| --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
337
|
+
| `-a, --access` | Access level (only applies when creating a bucket) (default: private) |
|
|
338
|
+
| `--public` | Shorthand for --access public (only applies when creating a bucket) |
|
|
339
|
+
| `-s, --enable-snapshots` | Enable snapshots for the bucket (only applies when creating a bucket) (default: false) |
|
|
340
|
+
| `--allow-object-acl` | Allow per-object ACLs on the bucket (only applies when creating a bucket) (default: false) |
|
|
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) |
|
|
343
|
+
| `-t, --default-tier` | Default storage tier (only applies when creating a bucket) (default: STANDARD) |
|
|
344
|
+
| `-l, --locations` | Location for the bucket (only applies when creating a bucket) (default: global) |
|
|
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/
|
|
@@ -365,13 +381,14 @@ Show storage stats (no args), bucket info, or object metadata
|
|
|
365
381
|
tigris stat [path] [flags]
|
|
366
382
|
```
|
|
367
383
|
|
|
368
|
-
| Flag
|
|
369
|
-
|
|
370
|
-
| `--format`
|
|
384
|
+
| Flag | Description |
|
|
385
|
+
| ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
386
|
+
| `--format` | Output format (default: table) |
|
|
371
387
|
| `-snapshot, --snapshot-version` | Read from a specific bucket snapshot. Accepts a snapshot version string or any UNIX nanosecond-precision timestamp (e.g. 1765889000501544464) |
|
|
372
|
-
| `--version-id`
|
|
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
|
|
@@ -386,16 +403,17 @@ Generate a presigned URL for temporary access to an object without credentials
|
|
|
386
403
|
tigris presign <path> [flags]
|
|
387
404
|
```
|
|
388
405
|
|
|
389
|
-
| Flag
|
|
390
|
-
|
|
391
|
-
| `-m, --method`
|
|
392
|
-
| `-e, --expires-in`
|
|
393
|
-
| `--access-key`
|
|
394
|
-
| `--select`
|
|
395
|
-
| `--format`
|
|
406
|
+
| Flag | Description |
|
|
407
|
+
| ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
408
|
+
| `-m, --method` | HTTP method for the presigned URL (default: get) |
|
|
409
|
+
| `-e, --expires-in` | URL expiry time in seconds (default: 3600) |
|
|
410
|
+
| `--access-key` | Access key ID to use for signing. If not provided, resolved from credentials or auto-selected |
|
|
411
|
+
| `--select` | Interactively select an access key (OAuth only) |
|
|
412
|
+
| `--format` | Output format (default: url) |
|
|
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
|
|
@@ -411,13 +429,14 @@ Copy files between local filesystem and Tigris, or between paths within Tigris.
|
|
|
411
429
|
tigris cp <src> <dest> [flags]
|
|
412
430
|
```
|
|
413
431
|
|
|
414
|
-
| Flag
|
|
415
|
-
|
|
416
|
-
| `-r, --recursive` | Copy directories recursively
|
|
417
|
-
| `-a, --access`
|
|
432
|
+
| Flag | Description |
|
|
433
|
+
| ----------------- | ------------------------------------------------------------------------------------------- |
|
|
434
|
+
| `-r, --recursive` | Copy directories recursively |
|
|
435
|
+
| `-a, --access` | Access level for uploaded objects (only applies to local-to-remote uploads) |
|
|
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
|
|
@@ -435,13 +454,14 @@ Move (rename) objects within Tigris. Both source and destination must be remote
|
|
|
435
454
|
tigris mv <src> <dest> [flags]
|
|
436
455
|
```
|
|
437
456
|
|
|
438
|
-
| Flag
|
|
439
|
-
|
|
440
|
-
| `-y, --yes`
|
|
441
|
-
| `-r, --recursive` | Move directories recursively
|
|
442
|
-
| `-f, --force`
|
|
457
|
+
| Flag | Description |
|
|
458
|
+
| ----------------- | ------------------------------------------- |
|
|
459
|
+
| `-y, --yes` | Skip confirmation prompts |
|
|
460
|
+
| `-r, --recursive` | Move directories recursively |
|
|
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
|
|
@@ -456,13 +476,14 @@ Remove a bucket, folder, or object from Tigris. A bare bucket name deletes the b
|
|
|
456
476
|
tigris rm <path> [flags]
|
|
457
477
|
```
|
|
458
478
|
|
|
459
|
-
| Flag
|
|
460
|
-
|
|
461
|
-
| `-y, --yes`
|
|
462
|
-
| `-r, --recursive` | Remove directories recursively
|
|
463
|
-
| `-f, --force`
|
|
479
|
+
| Flag | Description |
|
|
480
|
+
| ----------------- | ------------------------------------------- |
|
|
481
|
+
| `-y, --yes` | Skip confirmation prompts |
|
|
482
|
+
| `-r, --recursive` | Remove directories recursively |
|
|
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
|
|
@@ -478,14 +499,15 @@ Download multiple objects as a streaming tar archive in a single request. Design
|
|
|
478
499
|
tigris bundle <bucket> [flags]
|
|
479
500
|
```
|
|
480
501
|
|
|
481
|
-
| Flag
|
|
482
|
-
|
|
483
|
-
| `-k, --keys`
|
|
484
|
-
| `-o, --output`
|
|
485
|
-
| `--compression` | Compression algorithm for the archive. Auto-detected from output file extension when not specified
|
|
486
|
-
| `--on-error`
|
|
502
|
+
| Flag | Description |
|
|
503
|
+
| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
504
|
+
| `-k, --keys` | Comma-separated object keys, or path to a file with one key per line. If a local file matching the value exists, it is read as a keys file. If omitted, reads keys from stdin |
|
|
505
|
+
| `-o, --output` | Output file path. Defaults to stdout (for piping) |
|
|
506
|
+
| `--compression` | Compression algorithm for the archive. Auto-detected from output file extension when not specified |
|
|
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
|
|
@@ -497,11 +519,11 @@ cat keys.txt | tigris bundle my-bucket > archive.tar
|
|
|
497
519
|
|
|
498
520
|
List, create, and switch between organizations. An organization is a workspace that contains your resources like buckets and access keys
|
|
499
521
|
|
|
500
|
-
| Command
|
|
501
|
-
|
|
502
|
-
| `tigris organizations list` (l)
|
|
503
|
-
| `tigris organizations create` (c) | Create a new organization with the given name
|
|
504
|
-
| `tigris organizations select` (s) | Set the named organization as your active org for all subsequent commands
|
|
522
|
+
| Command | Description |
|
|
523
|
+
| --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
524
|
+
| `tigris organizations list` (l) | List all organizations you belong to and interactively select one as active |
|
|
525
|
+
| `tigris organizations create` (c) | Create a new organization with the given name |
|
|
526
|
+
| `tigris organizations select` (s) | Set the named organization as your active org for all subsequent commands |
|
|
505
527
|
| `tigris organizations delete` (d) | Delete an organization you own, picked from a list or given by ID. It must be empty first (no buckets, access keys, policies, teams, or other members); only its shares and invitations are removed with it. Your last organization cannot be deleted. Requires OAuth login and is not available for Fly.io organizations |
|
|
506
528
|
|
|
507
529
|
#### `tigris organizations list` (l)
|
|
@@ -512,12 +534,13 @@ List all organizations you belong to and interactively select one as active
|
|
|
512
534
|
tigris organizations list [flags]
|
|
513
535
|
```
|
|
514
536
|
|
|
515
|
-
| Flag
|
|
516
|
-
|
|
517
|
-
| `--format`
|
|
518
|
-
| `-i, --select` | Interactive selection mode
|
|
537
|
+
| Flag | Description |
|
|
538
|
+
| -------------- | ------------------------------- |
|
|
539
|
+
| `--format` | Output format (default: select) |
|
|
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
|
```
|
|
@@ -557,11 +582,12 @@ Delete an organization you own, picked from a list or given by ID. It must be em
|
|
|
557
582
|
tigris organizations delete [id] [flags]
|
|
558
583
|
```
|
|
559
584
|
|
|
560
|
-
| Flag
|
|
561
|
-
|
|
585
|
+
| Flag | Description |
|
|
586
|
+
| ----------- | ------------------------- |
|
|
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
|
|
@@ -571,26 +597,26 @@ tigris orgs delete <org-id> --yes
|
|
|
571
597
|
|
|
572
598
|
Create, inspect, update, and delete buckets. Buckets are top-level containers that hold objects
|
|
573
599
|
|
|
574
|
-
| Command
|
|
575
|
-
|
|
576
|
-
| `tigris buckets list` (l)
|
|
577
|
-
| `tigris buckets create` (c)
|
|
578
|
-
| `tigris buckets rebase`
|
|
579
|
-
| `tigris buckets merge`
|
|
580
|
-
| `tigris buckets get` (g)
|
|
581
|
-
| `tigris buckets delete` (d)
|
|
582
|
-
| `tigris buckets restore`
|
|
583
|
-
| `tigris buckets purge` (pg)
|
|
584
|
-
| `tigris buckets set` (s)
|
|
585
|
-
| `tigris buckets enable-snapshots`
|
|
586
|
-
| `tigris buckets disable-snapshots` | Disable snapshots on an existing bucket, converting it back to a regular bucket. Rejected while the bucket has dependent forks
|
|
587
|
-
| `tigris buckets set-locations`
|
|
588
|
-
| `tigris buckets set-migration`
|
|
589
|
-
| `tigris buckets migrate`
|
|
590
|
-
| `tigris buckets lifecycle` (lc)
|
|
591
|
-
| `tigris buckets set-notifications` | Configure object event notifications on a bucket. Sends webhook requests to a URL when objects are created, updated, or deleted
|
|
592
|
-
| `tigris buckets set-cors`
|
|
593
|
-
| `tigris buckets share`
|
|
600
|
+
| Command | Description |
|
|
601
|
+
| ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
602
|
+
| `tigris buckets list` (l) | List all buckets in the current organization |
|
|
603
|
+
| `tigris buckets create` (c) | Create a new bucket with optional access, tier, and location settings |
|
|
604
|
+
| `tigris buckets rebase` | Update a fork with the latest changes from its source bucket |
|
|
605
|
+
| `tigris buckets merge` | Merge a fork's changes back into its source bucket |
|
|
606
|
+
| `tigris buckets get` (g) | Show details for a bucket including access level, region, tier, and custom domain |
|
|
607
|
+
| `tigris buckets delete` (d) | Delete one or more buckets by name. The bucket must be empty or delete-protection must be off |
|
|
608
|
+
| `tigris buckets restore` | Restore a soft-deleted bucket within its retention window. List recoverable buckets with "tigris buckets list --deleted" |
|
|
609
|
+
| `tigris buckets purge` (pg) | Permanently destroy one or more soft-deleted buckets before their retention period expires. This cannot be undone — they can no longer be restored with "tigris buckets restore". List them with "tigris buckets list --deleted" |
|
|
610
|
+
| `tigris buckets set` (s) | Update settings on an existing bucket such as access level, default tier, location, caching, or custom domain |
|
|
611
|
+
| `tigris buckets enable-snapshots` | Enable snapshots on an existing bucket, converting it to a snapshot bucket |
|
|
612
|
+
| `tigris buckets disable-snapshots` | Disable snapshots on an existing bucket, converting it back to a regular bucket. Rejected while the bucket has dependent forks |
|
|
613
|
+
| `tigris buckets set-locations` | Set the data locations for a bucket |
|
|
614
|
+
| `tigris buckets set-migration` | Configure data migration from an external S3-compatible source bucket. Tigris will pull objects on demand from the source |
|
|
615
|
+
| `tigris buckets migrate` | Actively migrate all objects from a shadow bucket to Tigris by scheduling server-side migration for unmigrated objects |
|
|
616
|
+
| `tigris buckets lifecycle` (lc) | Manage bucket lifecycle rules. Each rule combines an optional storage-class transition and/or expiration (TTL), scoped to an optional key prefix |
|
|
617
|
+
| `tigris buckets set-notifications` | Configure object event notifications on a bucket. Sends webhook requests to a URL when objects are created, updated, or deleted |
|
|
618
|
+
| `tigris buckets set-cors` | Configure CORS rules on a bucket. Each invocation adds a rule unless --override or --reset is used |
|
|
619
|
+
| `tigris buckets share` | Share a bucket with your whole organization, specific teams, or specific users. Existing shares are kept unless --override or --reset is used |
|
|
594
620
|
|
|
595
621
|
#### `tigris buckets list` (l)
|
|
596
622
|
|
|
@@ -600,17 +626,18 @@ List all buckets in the current organization
|
|
|
600
626
|
tigris buckets list [flags]
|
|
601
627
|
```
|
|
602
628
|
|
|
603
|
-
| Flag
|
|
604
|
-
|
|
605
|
-
| `--format`
|
|
606
|
-
| `--forks-of`
|
|
607
|
-
| `--deleted`
|
|
608
|
-
| `--forks-only`
|
|
609
|
-
| `--owner`
|
|
610
|
-
| `--limit`
|
|
611
|
-
| `-pt, --page-token` | Pagination token from a previous request to fetch the next page
|
|
629
|
+
| Flag | Description |
|
|
630
|
+
| ------------------- | -------------------------------------------------------------------- |
|
|
631
|
+
| `--format` | Output format (default: table) |
|
|
632
|
+
| `--forks-of` | Only list buckets that are forks of the named source bucket |
|
|
633
|
+
| `--deleted` | Only list soft-deleted buckets |
|
|
634
|
+
| `--forks-only` | Only list buckets that are forks of another bucket |
|
|
635
|
+
| `--owner` | Only list buckets owned by this user, by username (an email address) |
|
|
636
|
+
| `--limit` | Maximum number of items to return per page |
|
|
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
|
|
632
|
-
|
|
633
|
-
| `-a, --access`
|
|
634
|
-
| `--public`
|
|
635
|
-
| `-s, --enable-snapshots`
|
|
636
|
-
| `--allow-object-acl`
|
|
637
|
-
| `--enable-directory-listing`
|
|
638
|
-
|
|
|
639
|
-
|
|
|
640
|
-
|
|
|
641
|
-
| `-
|
|
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
|
```
|
|
@@ -659,11 +692,12 @@ Update a fork with the latest changes from its source bucket
|
|
|
659
692
|
tigris buckets rebase <fork> [flags]
|
|
660
693
|
```
|
|
661
694
|
|
|
662
|
-
| Flag
|
|
663
|
-
|
|
695
|
+
| Flag | Description |
|
|
696
|
+
| ----------- | ------------------------- |
|
|
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
|
|
@@ -677,13 +711,14 @@ Merge a fork's changes back into its source bucket
|
|
|
677
711
|
tigris buckets merge <fork> [flags]
|
|
678
712
|
```
|
|
679
713
|
|
|
680
|
-
| Flag
|
|
681
|
-
|
|
682
|
-
| `-y, --yes`
|
|
683
|
-
| `-source, --into`
|
|
714
|
+
| Flag | Description |
|
|
715
|
+
| ----------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
716
|
+
| `-y, --yes` | Skip confirmation prompts |
|
|
717
|
+
| `-source, --into` | Source bucket to merge into. Defaults to the fork's parent source bucket |
|
|
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
|
|
@@ -699,11 +734,12 @@ Show details for a bucket including access level, region, tier, and custom domai
|
|
|
699
734
|
tigris buckets get <name> [flags]
|
|
700
735
|
```
|
|
701
736
|
|
|
702
|
-
| Flag
|
|
703
|
-
|
|
737
|
+
| Flag | Description |
|
|
738
|
+
| ---------- | ------------------------------ |
|
|
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
|
```
|
|
@@ -716,12 +752,13 @@ Delete one or more buckets by name. The bucket must be empty or delete-protectio
|
|
|
716
752
|
tigris buckets delete <name> [flags]
|
|
717
753
|
```
|
|
718
754
|
|
|
719
|
-
| Flag
|
|
720
|
-
|
|
721
|
-
| `-y, --yes` | Skip confirmation prompts
|
|
722
|
-
| `--force`
|
|
755
|
+
| Flag | Description |
|
|
756
|
+
| ----------- | ------------------------------------------- |
|
|
757
|
+
| `-y, --yes` | Skip confirmation prompts |
|
|
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
|
```
|
|
@@ -748,12 +786,13 @@ Permanently destroy one or more soft-deleted buckets before their retention peri
|
|
|
748
786
|
tigris buckets purge <name> [flags]
|
|
749
787
|
```
|
|
750
788
|
|
|
751
|
-
| Flag
|
|
752
|
-
|
|
753
|
-
| `-y, --yes` | Skip confirmation prompts
|
|
754
|
-
| `--force`
|
|
789
|
+
| Flag | Description |
|
|
790
|
+
| ----------- | ------------------------------------------- |
|
|
791
|
+
| `-y, --yes` | Skip confirmation prompts |
|
|
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
|
|
@@ -767,21 +806,22 @@ Update settings on an existing bucket such as access level, default tier, locati
|
|
|
767
806
|
tigris buckets set <name> [flags]
|
|
768
807
|
```
|
|
769
808
|
|
|
770
|
-
| Flag
|
|
771
|
-
|
|
772
|
-
| `--access`
|
|
773
|
-
| `--default-tier`
|
|
774
|
-
| `--locations`
|
|
775
|
-
| `--allow-object-acl`
|
|
776
|
-
| `--disable-directory-listing` | Disable directory listing
|
|
777
|
-
| `--cache-control`
|
|
778
|
-
| `--custom-domain`
|
|
779
|
-
| `--enable-delete-protection`
|
|
780
|
-
| `--soft-delete`
|
|
781
|
-
| `--retention-days`
|
|
782
|
-
| `--enable-additional-headers` | Enable additional HTTP headers (X-Content-Type-Options nosniff)
|
|
809
|
+
| Flag | Description |
|
|
810
|
+
| ----------------------------- | -------------------------------------------------------------------------------------------- |
|
|
811
|
+
| `--access` | Bucket access level |
|
|
812
|
+
| `--default-tier` | Change the default storage tier for objects uploaded to the bucket |
|
|
813
|
+
| `--locations` | Bucket location (see https://www.tigrisdata.com/docs/buckets/locations/ for more details) |
|
|
814
|
+
| `--allow-object-acl` | Enable object-level ACL |
|
|
815
|
+
| `--disable-directory-listing` | Disable directory listing |
|
|
816
|
+
| `--cache-control` | Default cache-control header value |
|
|
817
|
+
| `--custom-domain` | Custom domain for the bucket |
|
|
818
|
+
| `--enable-delete-protection` | Enable delete protection |
|
|
819
|
+
| `--soft-delete` | Enable or disable soft delete (recoverable deletes). Requires --retention-days when enabling |
|
|
820
|
+
| `--retention-days` | Number of days to retain soft-deleted objects (required when enabling --soft-delete) |
|
|
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
|
```
|
|
@@ -825,11 +867,12 @@ Set the data locations for a bucket
|
|
|
825
867
|
tigris buckets set-locations <name> [flags]
|
|
826
868
|
```
|
|
827
869
|
|
|
828
|
-
| Flag
|
|
829
|
-
|
|
870
|
+
| Flag | Description |
|
|
871
|
+
| ----------------- | --------------- |
|
|
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
|
|
848
|
-
|
|
849
|
-
| `-b, --bucket`
|
|
850
|
-
| `-e, --endpoint`
|
|
851
|
-
| `-r, --region`
|
|
852
|
-
| `-key, --access-key`
|
|
853
|
-
| `-secret, --secret-key` | Secret key for the source bucket
|
|
854
|
-
| `--write-through`
|
|
855
|
-
| `--
|
|
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
|
|
|
@@ -869,11 +915,12 @@ Actively migrate all objects from a shadow bucket to Tigris by scheduling server
|
|
|
869
915
|
tigris buckets migrate <path> [flags]
|
|
870
916
|
```
|
|
871
917
|
|
|
872
|
-
| Flag
|
|
873
|
-
|
|
918
|
+
| Flag | Description |
|
|
919
|
+
| -------------------- | ---------------------------------------------------------------------------------------------------------- |
|
|
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/
|
|
@@ -885,11 +932,11 @@ tigris buckets migrate my-bucket --max-in-flight-gb 100
|
|
|
885
932
|
|
|
886
933
|
Manage bucket lifecycle rules. Each rule combines an optional storage-class transition and/or expiration (TTL), scoped to an optional key prefix
|
|
887
934
|
|
|
888
|
-
| Command
|
|
889
|
-
|
|
890
|
-
| `tigris buckets lifecycle list` (l)
|
|
935
|
+
| Command | Description |
|
|
936
|
+
| ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
937
|
+
| `tigris buckets lifecycle list` (l) | List lifecycle rules on a bucket |
|
|
891
938
|
| `tigris buckets lifecycle create` (c) | Create a new lifecycle rule. A rule must include a transition (--storage-class with --days or --date) and/or an expiration (--expire-days or --expire-date), and may optionally be scoped via --prefix |
|
|
892
|
-
| `tigris buckets lifecycle edit` (e)
|
|
939
|
+
| `tigris buckets lifecycle edit` (e) | Edit an existing lifecycle rule by its id. Only specified fields are changed |
|
|
893
940
|
|
|
894
941
|
##### `tigris buckets lifecycle list` (l)
|
|
895
942
|
|
|
@@ -899,11 +946,12 @@ List lifecycle rules on a bucket
|
|
|
899
946
|
tigris buckets lifecycle list <name> [flags]
|
|
900
947
|
```
|
|
901
948
|
|
|
902
|
-
| Flag
|
|
903
|
-
|
|
949
|
+
| Flag | Description |
|
|
950
|
+
| ---------- | ------------------------------ |
|
|
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
|
|
@@ -917,17 +965,18 @@ Create a new lifecycle rule. A rule must include a transition (--storage-class w
|
|
|
917
965
|
tigris buckets lifecycle create <name> [flags]
|
|
918
966
|
```
|
|
919
967
|
|
|
920
|
-
| Flag
|
|
921
|
-
|
|
922
|
-
| `-p, --prefix`
|
|
923
|
-
| `-s, --storage-class` | Target storage class for the transition
|
|
924
|
-
| `-d, --days`
|
|
925
|
-
| `--date`
|
|
926
|
-
| `--expire-days`
|
|
927
|
-
| `--expire-date`
|
|
928
|
-
| `--disable`
|
|
968
|
+
| Flag | Description |
|
|
969
|
+
| --------------------- | --------------------------------------------------------------------------------------- |
|
|
970
|
+
| `-p, --prefix` | Key prefix to scope the rule to. Omit for a bucket-wide rule |
|
|
971
|
+
| `-s, --storage-class` | Target storage class for the transition |
|
|
972
|
+
| `-d, --days` | Transition objects after this many days (used with --storage-class) |
|
|
973
|
+
| `--date` | Transition objects on this date (ISO-8601, e.g. 2026-06-01) (used with --storage-class) |
|
|
974
|
+
| `--expire-days` | Expire (delete) objects after this many days |
|
|
975
|
+
| `--expire-date` | Expire (delete) objects on this date (ISO-8601, e.g. 2026-06-01) |
|
|
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
|
|
@@ -943,18 +992,19 @@ Edit an existing lifecycle rule by its id. Only specified fields are changed
|
|
|
943
992
|
tigris buckets lifecycle edit <name> <id> [flags]
|
|
944
993
|
```
|
|
945
994
|
|
|
946
|
-
| Flag
|
|
947
|
-
|
|
948
|
-
| `-p, --prefix`
|
|
949
|
-
| `-s, --storage-class` | Replace the rule's transition target
|
|
950
|
-
| `-d, --days`
|
|
951
|
-
| `--date`
|
|
952
|
-
| `--expire-days`
|
|
953
|
-
| `--expire-date`
|
|
954
|
-
| `--enable`
|
|
955
|
-
| `--disable`
|
|
995
|
+
| Flag | Description |
|
|
996
|
+
| --------------------- | --------------------------------------------- |
|
|
997
|
+
| `-p, --prefix` | Replace the rule's key prefix |
|
|
998
|
+
| `-s, --storage-class` | Replace the rule's transition target |
|
|
999
|
+
| `-d, --days` | Replace the rule's transition days |
|
|
1000
|
+
| `--date` | Replace the rule's transition date (ISO-8601) |
|
|
1001
|
+
| `--expire-days` | Replace the rule's expiration days |
|
|
1002
|
+
| `--expire-date` | Replace the rule's expiration date (ISO-8601) |
|
|
1003
|
+
| `--enable` | Enable the rule |
|
|
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
|
|
@@ -969,18 +1019,19 @@ Configure object event notifications on a bucket. Sends webhook requests to a UR
|
|
|
969
1019
|
tigris buckets set-notifications <name> [flags]
|
|
970
1020
|
```
|
|
971
1021
|
|
|
972
|
-
| Flag
|
|
973
|
-
|
|
974
|
-
| `-u, --url`
|
|
1022
|
+
| Flag | Description |
|
|
1023
|
+
| -------------- | ---------------------------------------------------------------------------- |
|
|
1024
|
+
| `-u, --url` | Webhook URL to send notifications to (must be http or https) |
|
|
975
1025
|
| `-f, --filter` | SQL WHERE clause to filter events by key (e.g. WHERE `key` REGEXP "^images") |
|
|
976
|
-
| `-t, --token`
|
|
977
|
-
| `--username`
|
|
978
|
-
| `--password`
|
|
979
|
-
| `--enable`
|
|
980
|
-
| `--disable`
|
|
981
|
-
| `--reset`
|
|
1026
|
+
| `-t, --token` | Token for webhook authentication |
|
|
1027
|
+
| `--username` | Username for basic webhook authentication |
|
|
1028
|
+
| `--password` | Password for basic webhook authentication |
|
|
1029
|
+
| `--enable` | Enable notifications on the bucket (uses existing config) |
|
|
1030
|
+
| `--disable` | Disable notifications on the bucket (preserves existing config) |
|
|
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
|
|
@@ -999,17 +1050,18 @@ Configure CORS rules on a bucket. Each invocation adds a rule unless --override
|
|
|
999
1050
|
tigris buckets set-cors <name> [flags]
|
|
1000
1051
|
```
|
|
1001
1052
|
|
|
1002
|
-
| Flag
|
|
1003
|
-
|
|
1004
|
-
| `-o, --origins`
|
|
1005
|
-
| `-m, --methods`
|
|
1006
|
-
| `--headers`
|
|
1007
|
-
| `--expose-headers` | Response headers to expose (comma-separated)
|
|
1008
|
-
| `--max-age`
|
|
1009
|
-
| `--override`
|
|
1010
|
-
| `--reset`
|
|
1053
|
+
| Flag | Description |
|
|
1054
|
+
| ------------------ | --------------------------------------------------------- |
|
|
1055
|
+
| `-o, --origins` | Allowed origins (comma-separated, or '*' for all) |
|
|
1056
|
+
| `-m, --methods` | Allowed HTTP methods (comma-separated, e.g. GET,POST,PUT) |
|
|
1057
|
+
| `--headers` | Allowed request headers (comma-separated, or '*' for all) |
|
|
1058
|
+
| `--expose-headers` | Response headers to expose (comma-separated) |
|
|
1059
|
+
| `--max-age` | Preflight cache duration in seconds (default: 3600) |
|
|
1060
|
+
| `--override` | Replace all existing CORS rules instead of appending |
|
|
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
|
|
@@ -1025,16 +1077,17 @@ Share a bucket with your whole organization, specific teams, or specific users.
|
|
|
1025
1077
|
tigris buckets share <name> [flags]
|
|
1026
1078
|
```
|
|
1027
1079
|
|
|
1028
|
-
| Flag
|
|
1029
|
-
|
|
1030
|
-
| `-org, --organization` | Give access to everyone in your organization. Takes exactly one --role and cannot be combined with --team or --user
|
|
1031
|
-
| `-t, --team`
|
|
1032
|
-
| `-u, --user`
|
|
1033
|
-
| `-r, --role`
|
|
1034
|
-
| `--override`
|
|
1035
|
-
| `--reset`
|
|
1080
|
+
| Flag | Description |
|
|
1081
|
+
| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1082
|
+
| `-org, --organization` | Give access to everyone in your organization. Takes exactly one --role and cannot be combined with --team or --user |
|
|
1083
|
+
| `-t, --team` | Team ID to share with (can specify multiple, comma-separated). Each team is paired positionally with a --role value |
|
|
1084
|
+
| `-u, --user` | User ID to share with (can specify multiple, comma-separated). Each user is paired positionally with a --role value |
|
|
1085
|
+
| `-r, --role` | Role to grant (can specify multiple, comma-separated). A single role applies to every target; otherwise each role pairs with the corresponding --team or --user value |
|
|
1086
|
+
| `--override` | Replace all existing shares instead of merging with them |
|
|
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
|
|
@@ -1048,10 +1101,10 @@ tigris buckets share my-bucket --reset
|
|
|
1048
1101
|
|
|
1049
1102
|
List, take, and delete snapshots. A snapshot is a point-in-time, read-only copy of a bucket's state
|
|
1050
1103
|
|
|
1051
|
-
| Command
|
|
1052
|
-
|
|
1053
|
-
| `tigris snapshots list` (l)
|
|
1054
|
-
| `tigris snapshots take` (t)
|
|
1104
|
+
| Command | Description |
|
|
1105
|
+
| ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
|
|
1106
|
+
| `tigris snapshots list` (l) | List all snapshots for the given bucket, ordered by creation time |
|
|
1107
|
+
| `tigris snapshots take` (t) | Take a new snapshot of the bucket's current state. Optionally provide a name for the snapshot |
|
|
1055
1108
|
| `tigris snapshots delete` (d) | Delete one or more snapshots of a bucket by version. Deletion is permanent; forks already created from a snapshot are unaffected |
|
|
1056
1109
|
|
|
1057
1110
|
#### `tigris snapshots list` (l)
|
|
@@ -1062,13 +1115,14 @@ List all snapshots for the given bucket, ordered by creation time
|
|
|
1062
1115
|
tigris snapshots list <name> [flags]
|
|
1063
1116
|
```
|
|
1064
1117
|
|
|
1065
|
-
| Flag
|
|
1066
|
-
|
|
1067
|
-
| `--format`
|
|
1068
|
-
| `--limit`
|
|
1118
|
+
| Flag | Description |
|
|
1119
|
+
| ------------------- | --------------------------------------------------------------- |
|
|
1120
|
+
| `--format` | Output format (default: table) |
|
|
1121
|
+
| `--limit` | Maximum number of items to return per page |
|
|
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
|
|
@@ -1096,12 +1151,13 @@ Delete one or more snapshots of a bucket by version. Deletion is permanent; fork
|
|
|
1096
1151
|
tigris snapshots delete <name> <version> [flags]
|
|
1097
1152
|
```
|
|
1098
1153
|
|
|
1099
|
-
| Flag
|
|
1100
|
-
|
|
1101
|
-
| `-y, --yes` | Skip confirmation prompts
|
|
1102
|
-
| `--force`
|
|
1154
|
+
| Flag | Description |
|
|
1155
|
+
| ----------- | ------------------------------------------- |
|
|
1156
|
+
| `-y, --yes` | Skip confirmation prompts |
|
|
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
|
|
@@ -1111,20 +1167,20 @@ tigris snapshots delete my-bucket 1765889000501544464,1765889000501544465 --yes
|
|
|
1111
1167
|
|
|
1112
1168
|
Low-level object operations for listing, downloading, uploading, and deleting individual objects in a bucket
|
|
1113
1169
|
|
|
1114
|
-
| Command
|
|
1115
|
-
|
|
1116
|
-
| `tigris objects list` (l)
|
|
1117
|
-
| `tigris objects list-versions` (lv)
|
|
1118
|
-
| `tigris objects get` (g)
|
|
1119
|
-
| `tigris objects put` (p)
|
|
1120
|
-
| `tigris objects delete` (d)
|
|
1121
|
-
| `tigris objects set` (s)
|
|
1122
|
-
| `tigris objects set-access` (sa)
|
|
1123
|
-
| `tigris objects info` (i)
|
|
1124
|
-
| `tigris objects restore` (rs)
|
|
1125
|
-
| `tigris objects restore-info` (ri)
|
|
1126
|
-
| `tigris objects restore-deleted` (rd) | Restore a soft-deleted object within its retention window. List recoverable objects with "tigris objects list --deleted", then pick a version with "tigris objects list-versions --deleted"
|
|
1127
|
-
| `tigris objects purge` (pg)
|
|
1170
|
+
| Command | Description |
|
|
1171
|
+
| ------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1172
|
+
| `tigris objects list` (l) | List objects in a bucket, optionally filtered by a key prefix |
|
|
1173
|
+
| `tigris objects list-versions` (lv) | List object versions and delete markers in a bucket (requires bucket versioning), or with --deleted the recoverable versions of soft-deleted objects. Returns both arrays separately to match the S3 ListObjectVersions response |
|
|
1174
|
+
| `tigris objects get` (g) | Download an object by key. Prints to stdout by default, or saves to a file with --output |
|
|
1175
|
+
| `tigris objects put` (p) | Upload a local file — or data piped via stdin — as an object. Content-type is auto-detected from the file extension unless overridden |
|
|
1176
|
+
| `tigris objects delete` (d) | Delete one or more objects by key from the given bucket. On a versioned bucket, the default creates a delete marker; use --version-id or --all-versions to hard-delete versions |
|
|
1177
|
+
| `tigris objects set` (s) | (Deprecated) Update settings on an existing object such as access level. Use `tigris objects set-access` for ACL changes and `tigris mv` to rename |
|
|
1178
|
+
| `tigris objects set-access` (sa) | Set the access level (public or private) on an existing object |
|
|
1179
|
+
| `tigris objects info` (i) | Show metadata for an object (content type, size, modified date) |
|
|
1180
|
+
| `tigris objects restore` (rs) | Restore an archived object (e.g. one in the GLACIER tier) into an actively-readable copy for a number of days |
|
|
1181
|
+
| `tigris objects restore-info` (ri) | Show the restore state of an archived object (archived, in-progress, or restored) |
|
|
1182
|
+
| `tigris objects restore-deleted` (rd) | Restore a soft-deleted object within its retention window. List recoverable objects with "tigris objects list --deleted", then pick a version with "tigris objects list-versions --deleted" |
|
|
1183
|
+
| `tigris objects purge` (pg) | Permanently destroy a soft-deleted object version before its retention period expires. This cannot be undone — the version can no longer be restored with "tigris objects restore-deleted" |
|
|
1128
1184
|
|
|
1129
1185
|
#### `tigris objects list` (l)
|
|
1130
1186
|
|
|
@@ -1134,17 +1190,18 @@ List objects in a bucket, optionally filtered by a key prefix
|
|
|
1134
1190
|
tigris objects list <bucket> [flags]
|
|
1135
1191
|
```
|
|
1136
1192
|
|
|
1137
|
-
| Flag
|
|
1138
|
-
|
|
1139
|
-
| `-p, --prefix`
|
|
1140
|
-
| `--format`
|
|
1141
|
-
| `-snapshot, --snapshot-version` | Read from a specific bucket snapshot. Accepts a snapshot version string or any UNIX nanosecond-precision timestamp (e.g. 1765889000501544464)
|
|
1142
|
-
| `--limit`
|
|
1143
|
-
| `-pt, --page-token`
|
|
1144
|
-
| `--source`
|
|
1145
|
-
| `--deleted`
|
|
1193
|
+
| Flag | Description |
|
|
1194
|
+
| ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1195
|
+
| `-p, --prefix` | Filter objects by key prefix (e.g. "images/" to list only images) |
|
|
1196
|
+
| `--format` | Output format (default: table) |
|
|
1197
|
+
| `-snapshot, --snapshot-version` | Read from a specific bucket snapshot. Accepts a snapshot version string or any UNIX nanosecond-precision timestamp (e.g. 1765889000501544464) |
|
|
1198
|
+
| `--limit` | Maximum number of items to return per page |
|
|
1199
|
+
| `-pt, --page-token` | Pagination token from a previous request to fetch the next page |
|
|
1200
|
+
| `--source` | List objects from a specific storage source on buckets with shadow migration enabled |
|
|
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
|
|
@@ -1162,17 +1219,18 @@ List object versions and delete markers in a bucket (requires bucket versioning)
|
|
|
1162
1219
|
tigris objects list-versions <bucket> [flags]
|
|
1163
1220
|
```
|
|
1164
1221
|
|
|
1165
|
-
| Flag
|
|
1166
|
-
|
|
1167
|
-
| `-p, --prefix`
|
|
1168
|
-
| `-d, --delimiter`
|
|
1169
|
-
| `--format`
|
|
1170
|
-
| `--limit`
|
|
1171
|
-
| `--key-marker`
|
|
1172
|
-
| `--version-id-marker` | Pagination marker — the version id to start listing from (from a prior nextVersionIdMarker)
|
|
1173
|
-
| `--deleted`
|
|
1222
|
+
| Flag | Description |
|
|
1223
|
+
| --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1224
|
+
| `-p, --prefix` | Filter by key prefix |
|
|
1225
|
+
| `-d, --delimiter` | Group keys sharing a common prefix up to the delimiter (e.g. "/" for folder-style grouping) |
|
|
1226
|
+
| `--format` | Output format (default: table) |
|
|
1227
|
+
| `--limit` | Maximum number of items to return per page |
|
|
1228
|
+
| `--key-marker` | Pagination marker — the key to start listing from (from a prior nextKeyMarker) |
|
|
1229
|
+
| `--version-id-marker` | Pagination marker — the version id to start listing from (from a prior nextVersionIdMarker) |
|
|
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/
|
|
@@ -1189,14 +1247,15 @@ Download an object by key. Prints to stdout by default, or saves to a file with
|
|
|
1189
1247
|
tigris objects get <bucket> [key] [flags]
|
|
1190
1248
|
```
|
|
1191
1249
|
|
|
1192
|
-
| Flag
|
|
1193
|
-
|
|
1194
|
-
| `-o, --output`
|
|
1195
|
-
| `-m, --mode`
|
|
1250
|
+
| Flag | Description |
|
|
1251
|
+
| ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1252
|
+
| `-o, --output` | Output file path (if not specified, prints to stdout) |
|
|
1253
|
+
| `-m, --mode` | Response mode: "string" loads into memory, "stream" writes in chunks (auto-detected from extension if not specified) |
|
|
1196
1254
|
| `-snapshot, --snapshot-version` | Read from a specific bucket snapshot. Accepts a snapshot version string or any UNIX nanosecond-precision timestamp (e.g. 1765889000501544464) |
|
|
1197
|
-
| `--version-id`
|
|
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
|
|
@@ -1211,14 +1270,15 @@ Upload a local file — or data piped via stdin — as an object. Content-type i
|
|
|
1211
1270
|
tigris objects put <bucket> [key] [file] [flags]
|
|
1212
1271
|
```
|
|
1213
1272
|
|
|
1214
|
-
| Flag
|
|
1215
|
-
|
|
1216
|
-
| `-a, --access`
|
|
1217
|
-
| `-t, --content-type` | Content type (auto-detected from extension if omitted)
|
|
1218
|
-
| `--cache-control`
|
|
1219
|
-
| `--format`
|
|
1273
|
+
| Flag | Description |
|
|
1274
|
+
| -------------------- | ------------------------------------------------------------------------------------------------------------------- |
|
|
1275
|
+
| `-a, --access` | Access level (default: private) |
|
|
1276
|
+
| `-t, --content-type` | Content type (auto-detected from extension if omitted) |
|
|
1277
|
+
| `--cache-control` | Cache-Control header stored with the object and returned on every read (e.g. "public, max-age=31536000, immutable") |
|
|
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
|
|
@@ -1236,14 +1296,15 @@ Delete one or more objects by key from the given bucket. On a versioned bucket,
|
|
|
1236
1296
|
tigris objects delete <bucket> [key] [flags]
|
|
1237
1297
|
```
|
|
1238
1298
|
|
|
1239
|
-
| Flag
|
|
1240
|
-
|
|
1241
|
-
| `-y, --yes`
|
|
1242
|
-
| `--version-id`
|
|
1243
|
-
| `--all-versions` | Hard-delete every version and delete marker for the given key(s). Mutually exclusive with --version-id
|
|
1244
|
-
| `--force`
|
|
1299
|
+
| Flag | Description |
|
|
1300
|
+
| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1301
|
+
| `-y, --yes` | Skip confirmation prompts |
|
|
1302
|
+
| `--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" |
|
|
1303
|
+
| `--all-versions` | Hard-delete every version and delete marker for the given key(s). Mutually exclusive with --version-id |
|
|
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
|
|
@@ -1260,12 +1321,13 @@ tigris objects delete my-bucket old-file.txt --all-versions --yes
|
|
|
1260
1321
|
tigris objects set <bucket> [key] [flags]
|
|
1261
1322
|
```
|
|
1262
1323
|
|
|
1263
|
-
| Flag
|
|
1264
|
-
|
|
1265
|
-
| `-a, --access`
|
|
1324
|
+
| Flag | Description |
|
|
1325
|
+
| --------------- | ------------------------------ |
|
|
1326
|
+
| `-a, --access` | Access level **(required)** |
|
|
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
|
|
@@ -1280,11 +1342,12 @@ Set the access level (public or private) on an existing object
|
|
|
1280
1342
|
tigris objects set-access <bucket> [key] [access] [flags]
|
|
1281
1343
|
```
|
|
1282
1344
|
|
|
1283
|
-
| Flag
|
|
1284
|
-
|
|
1345
|
+
| Flag | Description |
|
|
1346
|
+
| ---------- | ------------------------------ |
|
|
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
|
|
@@ -1298,13 +1361,14 @@ Show metadata for an object (content type, size, modified date)
|
|
|
1298
1361
|
tigris objects info <bucket> [key] [flags]
|
|
1299
1362
|
```
|
|
1300
1363
|
|
|
1301
|
-
| Flag
|
|
1302
|
-
|
|
1303
|
-
| `--format`
|
|
1304
|
-
| `-snapshot, --snapshot-version` | Read from a specific bucket snapshot
|
|
1305
|
-
| `--version-id`
|
|
1364
|
+
| Flag | Description |
|
|
1365
|
+
| ------------------------------- | ------------------------------------------------------------------------------- |
|
|
1366
|
+
| `--format` | Output format (default: table) |
|
|
1367
|
+
| `-snapshot, --snapshot-version` | Read from a specific bucket snapshot |
|
|
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
|
|
@@ -1320,14 +1384,15 @@ Restore an archived object (e.g. one in the GLACIER tier) into an actively-reada
|
|
|
1320
1384
|
tigris objects restore <bucket> [key] [flags]
|
|
1321
1385
|
```
|
|
1322
1386
|
|
|
1323
|
-
| Flag
|
|
1324
|
-
|
|
1325
|
-
| `-d, --days`
|
|
1326
|
-
| `--version-id`
|
|
1387
|
+
| Flag | Description |
|
|
1388
|
+
| ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1389
|
+
| `-d, --days` | How many days the restored copy stays available before reverting to its archived tier (default: 1) |
|
|
1390
|
+
| `--version-id` | Restore a specific object version (requires bucket versioning). Omit to restore the current version |
|
|
1327
1391
|
| `-snapshot, --snapshot-version` | Restore the object as of a specific bucket snapshot. Accepts a snapshot version string or any UNIX nanosecond-precision timestamp (e.g. 1765889000501544464) |
|
|
1328
|
-
| `--format`
|
|
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
|
|
@@ -1343,13 +1408,14 @@ Show the restore state of an archived object (archived, in-progress, or restored
|
|
|
1343
1408
|
tigris objects restore-info <bucket> [key] [flags]
|
|
1344
1409
|
```
|
|
1345
1410
|
|
|
1346
|
-
| Flag
|
|
1347
|
-
|
|
1348
|
-
| `--version-id`
|
|
1411
|
+
| Flag | Description |
|
|
1412
|
+
| ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1413
|
+
| `--version-id` | Inspect a specific object version (requires bucket versioning). Omit to read the current version |
|
|
1349
1414
|
| `-snapshot, --snapshot-version` | Inspect the object as of a specific bucket snapshot. Accepts a snapshot version string or any UNIX nanosecond-precision timestamp (e.g. 1765889000501544464) |
|
|
1350
|
-
| `--format`
|
|
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
|
|
@@ -1364,12 +1430,13 @@ Restore a soft-deleted object within its retention window. List recoverable obje
|
|
|
1364
1430
|
tigris objects restore-deleted <bucket> [key] [flags]
|
|
1365
1431
|
```
|
|
1366
1432
|
|
|
1367
|
-
| Flag
|
|
1368
|
-
|
|
1433
|
+
| Flag | Description |
|
|
1434
|
+
| -------------- | ---------------------------------------------------------------------------------------------------- |
|
|
1369
1435
|
| `--version-id` | The soft-deleted version to bring back, from "tigris objects list-versions --deleted" **(required)** |
|
|
1370
|
-
| `--format`
|
|
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
|
|
@@ -1383,14 +1450,15 @@ Permanently destroy a soft-deleted object version before its retention period ex
|
|
|
1383
1450
|
tigris objects purge <bucket> [key] [flags]
|
|
1384
1451
|
```
|
|
1385
1452
|
|
|
1386
|
-
| Flag
|
|
1387
|
-
|
|
1388
|
-
| `-y, --yes`
|
|
1453
|
+
| Flag | Description |
|
|
1454
|
+
| -------------- | ------------------------------------------------------------------------------------------------- |
|
|
1455
|
+
| `-y, --yes` | Skip confirmation prompts |
|
|
1389
1456
|
| `--version-id` | The soft-deleted version to destroy, from "tigris objects list-versions --deleted" **(required)** |
|
|
1390
|
-
| `--force`
|
|
1391
|
-
| `--format`
|
|
1457
|
+
| `--force` | Skip confirmation prompts (alias for --yes) |
|
|
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
|
|
@@ -1400,18 +1468,18 @@ tigris objects purge t3://my-bucket/report.pdf --version-id 1787749774802410496
|
|
|
1400
1468
|
|
|
1401
1469
|
Create, list, inspect, delete, and assign roles to access keys. Access keys are credentials used for programmatic API access
|
|
1402
1470
|
|
|
1403
|
-
| Command
|
|
1404
|
-
|
|
1405
|
-
| `tigris access-keys list` (l)
|
|
1406
|
-
| `tigris access-keys create` (c)
|
|
1407
|
-
| `tigris access-keys delete` (d)
|
|
1408
|
-
| `tigris access-keys get` (g)
|
|
1409
|
-
| `tigris access-keys assign` (a)
|
|
1410
|
-
| `tigris access-keys set` (s)
|
|
1411
|
-
| `tigris access-keys rotate` (r)
|
|
1412
|
-
| `tigris access-keys attach-policy` (ap) | Attach an IAM policy to an access key. If no policy ARN is provided, shows interactive selection of available policies
|
|
1413
|
-
| `tigris access-keys detach-policy` (dp) | Detach an IAM policy from an access key. If no policy ARN is provided, shows interactive selection of attached policies
|
|
1414
|
-
| `tigris access-keys list-policies` (lp) | List all IAM policies attached to an access key
|
|
1471
|
+
| Command | Description |
|
|
1472
|
+
| --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1473
|
+
| `tigris access-keys list` (l) | List all access keys in the current organization |
|
|
1474
|
+
| `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) |
|
|
1475
|
+
| `tigris access-keys delete` (d) | Permanently delete one or more access keys by ID. This revokes all access immediately |
|
|
1476
|
+
| `tigris access-keys get` (g) | Show details for an access key including its name, creation date, default permissions, and assigned bucket roles |
|
|
1477
|
+
| `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 |
|
|
1478
|
+
| `tigris access-keys set` (s) | Update settings on an existing access key — currently its default permissions, the console's "Enable default permissions" toggle. Bucket roles are left as they are |
|
|
1479
|
+
| `tigris access-keys rotate` (r) | Rotate an access key's secret. The current secret is immediately invalidated and a new one is returned (shown only once) |
|
|
1480
|
+
| `tigris access-keys attach-policy` (ap) | Attach an IAM policy to an access key. If no policy ARN is provided, shows interactive selection of available policies |
|
|
1481
|
+
| `tigris access-keys detach-policy` (dp) | Detach an IAM policy from an access key. If no policy ARN is provided, shows interactive selection of attached policies |
|
|
1482
|
+
| `tigris access-keys list-policies` (lp) | List all IAM policies attached to an access key |
|
|
1415
1483
|
|
|
1416
1484
|
#### `tigris access-keys list` (l)
|
|
1417
1485
|
|
|
@@ -1421,13 +1489,14 @@ List all access keys in the current organization
|
|
|
1421
1489
|
tigris access-keys list [flags]
|
|
1422
1490
|
```
|
|
1423
1491
|
|
|
1424
|
-
| Flag
|
|
1425
|
-
|
|
1426
|
-
| `--format`
|
|
1427
|
-
| `--limit`
|
|
1492
|
+
| Flag | Description |
|
|
1493
|
+
| ------------------- | --------------------------------------------------------------- |
|
|
1494
|
+
| `--format` | Output format (default: table) |
|
|
1495
|
+
| `--limit` | Maximum number of items to return per page |
|
|
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
|
```
|
|
@@ -1440,17 +1509,18 @@ Create a new access key, optionally scoped to buckets, and export its credential
|
|
|
1440
1509
|
tigris access-keys create <name> [flags]
|
|
1441
1510
|
```
|
|
1442
1511
|
|
|
1443
|
-
| Flag
|
|
1444
|
-
|
|
1445
|
-
| `-b, --bucket`
|
|
1446
|
-
| `-r, --role`
|
|
1447
|
-
| `--admin`
|
|
1512
|
+
| Flag | Description |
|
|
1513
|
+
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1514
|
+
| `-b, --bucket` | Bucket name (can specify multiple, comma-separated). Each bucket is paired positionally with a --role value |
|
|
1515
|
+
| `-r, --role` | Role to assign (can specify multiple, comma-separated). Each role pairs with the corresponding --bucket value |
|
|
1516
|
+
| `--admin` | Grant admin access to all buckets in the organization |
|
|
1448
1517
|
| `--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 |
|
|
1449
|
-
| `--env`
|
|
1450
|
-
| `--export`
|
|
1451
|
-
| `--for`
|
|
1518
|
+
| `--env` | Write the credentials to a dotenv file, merging into it when it already exists. Defaults to ./.env. The secret is then not printed |
|
|
1519
|
+
| `--export` | Print the credentials as shell "export" lines and nothing else on stdout, for eval "$(tigris access-keys create <name> --export)" |
|
|
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
|
|
@@ -1466,12 +1536,13 @@ Permanently delete one or more access keys by ID. This revokes all access immedi
|
|
|
1466
1536
|
tigris access-keys delete <id> [flags]
|
|
1467
1537
|
```
|
|
1468
1538
|
|
|
1469
|
-
| Flag
|
|
1470
|
-
|
|
1471
|
-
| `-y, --yes` | Skip confirmation prompts
|
|
1472
|
-
| `--force`
|
|
1539
|
+
| Flag | Description |
|
|
1540
|
+
| ----------- | ------------------------------------------- |
|
|
1541
|
+
| `-y, --yes` | Skip confirmation prompts |
|
|
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
|
```
|
|
@@ -1498,14 +1570,15 @@ Assign per-bucket roles to an access key. Pair each --bucket with a --role (Edit
|
|
|
1498
1570
|
tigris access-keys assign <id> [flags]
|
|
1499
1571
|
```
|
|
1500
1572
|
|
|
1501
|
-
| Flag
|
|
1502
|
-
|
|
1503
|
-
| `-b, --bucket`
|
|
1504
|
-
| `-r, --role`
|
|
1505
|
-
| `--admin`
|
|
1506
|
-
| `--revoke-roles` | Revoke all bucket roles from the access key
|
|
1573
|
+
| Flag | Description |
|
|
1574
|
+
| ---------------- | ------------------------------------------------------------------------------------------------------------- |
|
|
1575
|
+
| `-b, --bucket` | Bucket name (can specify multiple, comma-separated). Each bucket is paired positionally with a --role value |
|
|
1576
|
+
| `-r, --role` | Role to assign (can specify multiple, comma-separated). Each role pairs with the corresponding --bucket value |
|
|
1577
|
+
| `--admin` | Grant admin access to all buckets in the organization |
|
|
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
|
|
@@ -1521,11 +1594,12 @@ Update settings on an existing access key — currently its default permissions,
|
|
|
1521
1594
|
tigris access-keys set <id> [flags]
|
|
1522
1595
|
```
|
|
1523
1596
|
|
|
1524
|
-
| Flag
|
|
1525
|
-
|
|
1597
|
+
| Flag | Description |
|
|
1598
|
+
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
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
|
|
@@ -1539,12 +1613,13 @@ Rotate an access key's secret. The current secret is immediately invalidated and
|
|
|
1539
1613
|
tigris access-keys rotate <id> [flags]
|
|
1540
1614
|
```
|
|
1541
1615
|
|
|
1542
|
-
| Flag
|
|
1543
|
-
|
|
1544
|
-
| `-y, --yes` | Skip confirmation prompts
|
|
1545
|
-
| `--force`
|
|
1616
|
+
| Flag | Description |
|
|
1617
|
+
| ----------- | ------------------------------------------- |
|
|
1618
|
+
| `-y, --yes` | Skip confirmation prompts |
|
|
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
|
```
|
|
@@ -1557,11 +1632,12 @@ Attach an IAM policy to an access key. If no policy ARN is provided, shows inter
|
|
|
1557
1632
|
tigris access-keys attach-policy <id> [flags]
|
|
1558
1633
|
```
|
|
1559
1634
|
|
|
1560
|
-
| Flag
|
|
1561
|
-
|
|
1635
|
+
| Flag | Description |
|
|
1636
|
+
| -------------- | --------------------------- |
|
|
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
|
|
@@ -1575,13 +1651,14 @@ Detach an IAM policy from an access key. If no policy ARN is provided, shows int
|
|
|
1575
1651
|
tigris access-keys detach-policy <id> [flags]
|
|
1576
1652
|
```
|
|
1577
1653
|
|
|
1578
|
-
| Flag
|
|
1579
|
-
|
|
1580
|
-
| `-y, --yes`
|
|
1581
|
-
| `--policy-arn` | ARN of the policy to detach
|
|
1582
|
-
| `--force`
|
|
1654
|
+
| Flag | Description |
|
|
1655
|
+
| -------------- | ------------------------------------------- |
|
|
1656
|
+
| `-y, --yes` | Skip confirmation prompts |
|
|
1657
|
+
| `--policy-arn` | ARN of the policy to detach |
|
|
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
|
|
@@ -1595,13 +1672,14 @@ List all IAM policies attached to an access key
|
|
|
1595
1672
|
tigris access-keys list-policies <id> [flags]
|
|
1596
1673
|
```
|
|
1597
1674
|
|
|
1598
|
-
| Flag
|
|
1599
|
-
|
|
1600
|
-
| `--format`
|
|
1601
|
-
| `--limit`
|
|
1675
|
+
| Flag | Description |
|
|
1676
|
+
| ------------------- | --------------------------------------------------------------- |
|
|
1677
|
+
| `--format` | Output format (default: table) |
|
|
1678
|
+
| `--limit` | Maximum number of items to return per page |
|
|
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
|
```
|
|
@@ -1610,26 +1688,26 @@ tigris access-keys list-policies tid_AaBbCcDdEeFf
|
|
|
1610
1688
|
|
|
1611
1689
|
Identity and Access Management - manage policies, users, and permissions
|
|
1612
1690
|
|
|
1613
|
-
| Command
|
|
1614
|
-
|
|
1691
|
+
| Command | Description |
|
|
1692
|
+
| ------------------------- | ---------------------------------------------------------------- |
|
|
1615
1693
|
| `tigris iam policies` (p) | Manage IAM policies. Policies define permissions for access keys |
|
|
1616
|
-
| `tigris iam users` (u)
|
|
1617
|
-
| `tigris iam teams` (t)
|
|
1694
|
+
| `tigris iam users` (u) | Manage organization users and invitations |
|
|
1695
|
+
| `tigris iam teams` (t) | Manage organization teams |
|
|
1618
1696
|
|
|
1619
1697
|
#### `tigris iam policies` (p)
|
|
1620
1698
|
|
|
1621
1699
|
Manage IAM policies. Policies define permissions for access keys
|
|
1622
1700
|
|
|
1623
|
-
| Command
|
|
1624
|
-
|
|
1625
|
-
| `tigris iam policies list` (l)
|
|
1626
|
-
| `tigris iam policies get` (g)
|
|
1627
|
-
| `tigris iam policies create` (c)
|
|
1628
|
-
| `tigris iam policies edit` (e)
|
|
1629
|
-
| `tigris iam policies delete` (d)
|
|
1630
|
-
| `tigris iam policies link-key` (lnk)
|
|
1701
|
+
| Command | Description |
|
|
1702
|
+
| --------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1703
|
+
| `tigris iam policies list` (l) | List all policies in the current organization |
|
|
1704
|
+
| `tigris iam policies get` (g) | Show details for a policy including its document and attached users. If no ARN provided, shows interactive selection |
|
|
1705
|
+
| `tigris iam policies create` (c) | Create a new policy with the given name and policy document. Document can be provided via file, inline JSON, or stdin |
|
|
1706
|
+
| `tigris iam policies edit` (e) | Update an existing policy's document. Document can be provided via file, inline JSON, or stdin. If no ARN provided, shows interactive selection |
|
|
1707
|
+
| `tigris iam policies delete` (d) | Delete a policy. If no ARN provided, shows interactive selection |
|
|
1708
|
+
| `tigris iam policies link-key` (lnk) | Link an access key to a policy. If no policy ARN is provided, shows interactive selection. If no access key ID is provided, shows interactive selection of unlinked keys |
|
|
1631
1709
|
| `tigris iam policies unlink-key` (ulnk) | Unlink an access key from a policy. If no policy ARN is provided, shows interactive selection. If no access key ID is provided, shows interactive selection of linked keys |
|
|
1632
|
-
| `tigris iam policies list-keys` (lk)
|
|
1710
|
+
| `tigris iam policies list-keys` (lk) | List all access keys attached to a policy. If no policy ARN is provided, shows interactive selection |
|
|
1633
1711
|
|
|
1634
1712
|
##### `tigris iam policies list` (l)
|
|
1635
1713
|
|
|
@@ -1639,13 +1717,14 @@ List all policies in the current organization
|
|
|
1639
1717
|
tigris iam policies list [flags]
|
|
1640
1718
|
```
|
|
1641
1719
|
|
|
1642
|
-
| Flag
|
|
1643
|
-
|
|
1644
|
-
| `--format`
|
|
1645
|
-
| `--limit`
|
|
1720
|
+
| Flag | Description |
|
|
1721
|
+
| ------------------- | --------------------------------------------------------------- |
|
|
1722
|
+
| `--format` | Output format (default: table) |
|
|
1723
|
+
| `--limit` | Maximum number of items to return per page |
|
|
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
|
```
|
|
@@ -1658,11 +1737,12 @@ Show details for a policy including its document and attached users. If no ARN p
|
|
|
1658
1737
|
tigris iam policies get [resource] [flags]
|
|
1659
1738
|
```
|
|
1660
1739
|
|
|
1661
|
-
| Flag
|
|
1662
|
-
|
|
1740
|
+
| Flag | Description |
|
|
1741
|
+
| ---------- | ------------------------------ |
|
|
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
|
|
@@ -1676,12 +1756,13 @@ Create a new policy with the given name and policy document. Document can be pro
|
|
|
1676
1756
|
tigris iam policies create <name> [flags]
|
|
1677
1757
|
```
|
|
1678
1758
|
|
|
1679
|
-
| Flag
|
|
1680
|
-
|
|
1759
|
+
| Flag | Description |
|
|
1760
|
+
| ---------------- | ----------------------------------------------------------------------------- |
|
|
1681
1761
|
| `-d, --document` | Policy document (JSON file path or inline JSON). If omitted, reads from stdin |
|
|
1682
|
-
| `--description`
|
|
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":[...]}'
|
|
@@ -1696,12 +1777,13 @@ Update an existing policy's document. Document can be provided via file, inline
|
|
|
1696
1777
|
tigris iam policies edit [resource] [flags]
|
|
1697
1778
|
```
|
|
1698
1779
|
|
|
1699
|
-
| Flag
|
|
1700
|
-
|
|
1780
|
+
| Flag | Description |
|
|
1781
|
+
| ---------------- | --------------------------------------------------------------------------------- |
|
|
1701
1782
|
| `-d, --document` | New policy document (JSON file path or inline JSON). If omitted, reads from stdin |
|
|
1702
|
-
| `--description`
|
|
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
|
|
@@ -1716,12 +1798,13 @@ Delete a policy. If no ARN provided, shows interactive selection
|
|
|
1716
1798
|
tigris iam policies delete [resource] [flags]
|
|
1717
1799
|
```
|
|
1718
1800
|
|
|
1719
|
-
| Flag
|
|
1720
|
-
|
|
1721
|
-
| `-y, --yes` | Skip confirmation prompts
|
|
1722
|
-
| `--force`
|
|
1801
|
+
| Flag | Description |
|
|
1802
|
+
| ----------- | ------------------------------------------- |
|
|
1803
|
+
| `-y, --yes` | Skip confirmation prompts |
|
|
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
|
|
@@ -1735,11 +1818,12 @@ Link an access key to a policy. If no policy ARN is provided, shows interactive
|
|
|
1735
1818
|
tigris iam policies link-key [resource] [flags]
|
|
1736
1819
|
```
|
|
1737
1820
|
|
|
1738
|
-
| Flag
|
|
1739
|
-
|
|
1821
|
+
| Flag | Description |
|
|
1822
|
+
| ------ | ----------------------- |
|
|
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
|
|
@@ -1753,13 +1837,14 @@ Unlink an access key from a policy. If no policy ARN is provided, shows interact
|
|
|
1753
1837
|
tigris iam policies unlink-key [resource] [flags]
|
|
1754
1838
|
```
|
|
1755
1839
|
|
|
1756
|
-
| Flag
|
|
1757
|
-
|
|
1758
|
-
| `-y, --yes` | Skip confirmation prompts
|
|
1759
|
-
| `--id`
|
|
1760
|
-
| `--force`
|
|
1840
|
+
| Flag | Description |
|
|
1841
|
+
| ----------- | ------------------------------------------- |
|
|
1842
|
+
| `-y, --yes` | Skip confirmation prompts |
|
|
1843
|
+
| `--id` | Access key ID to detach |
|
|
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
|
|
@@ -1773,11 +1858,12 @@ List all access keys attached to a policy. If no policy ARN is provided, shows i
|
|
|
1773
1858
|
tigris iam policies list-keys [resource] [flags]
|
|
1774
1859
|
```
|
|
1775
1860
|
|
|
1776
|
-
| Flag
|
|
1777
|
-
|
|
1861
|
+
| Flag | Description |
|
|
1862
|
+
| ---------- | ------------------------------ |
|
|
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
|
|
@@ -1787,13 +1873,13 @@ tigris iam policies list-keys
|
|
|
1787
1873
|
|
|
1788
1874
|
Manage organization users and invitations
|
|
1789
1875
|
|
|
1790
|
-
| Command
|
|
1791
|
-
|
|
1792
|
-
| `tigris iam users list` (l)
|
|
1793
|
-
| `tigris iam users invite` (i)
|
|
1794
|
-
| `tigris iam users revoke-invitation` (ri) | Revoke pending invitations. If no invitation ID provided, shows interactive selection
|
|
1795
|
-
| `tigris iam users update-role` (ur)
|
|
1796
|
-
| `tigris iam users remove` (rm)
|
|
1876
|
+
| Command | Description |
|
|
1877
|
+
| ----------------------------------------- | ------------------------------------------------------------------------------------------ |
|
|
1878
|
+
| `tigris iam users list` (l) | List all users and pending invitations in the organization |
|
|
1879
|
+
| `tigris iam users invite` (i) | Invite users to the organization by email |
|
|
1880
|
+
| `tigris iam users revoke-invitation` (ri) | Revoke pending invitations. If no invitation ID provided, shows interactive selection |
|
|
1881
|
+
| `tigris iam users update-role` (ur) | Update user roles in the organization. If no user ID provided, shows interactive selection |
|
|
1882
|
+
| `tigris iam users remove` (rm) | Remove users from the organization. If no user ID provided, shows interactive selection |
|
|
1797
1883
|
|
|
1798
1884
|
##### `tigris iam users list` (l)
|
|
1799
1885
|
|
|
@@ -1803,11 +1889,12 @@ List all users and pending invitations in the organization
|
|
|
1803
1889
|
tigris iam users list [flags]
|
|
1804
1890
|
```
|
|
1805
1891
|
|
|
1806
|
-
| Flag
|
|
1807
|
-
|
|
1892
|
+
| Flag | Description |
|
|
1893
|
+
| ---------- | ------------------------------ |
|
|
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
|
|
@@ -1821,11 +1908,12 @@ Invite users to the organization by email
|
|
|
1821
1908
|
tigris iam users invite <email> [flags]
|
|
1822
1909
|
```
|
|
1823
1910
|
|
|
1824
|
-
| Flag
|
|
1825
|
-
|
|
1911
|
+
| Flag | Description |
|
|
1912
|
+
| ------------ | ------------------------------------------------------- |
|
|
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
|
|
@@ -1840,12 +1928,13 @@ Revoke pending invitations. If no invitation ID provided, shows interactive sele
|
|
|
1840
1928
|
tigris iam users revoke-invitation [resource] [flags]
|
|
1841
1929
|
```
|
|
1842
1930
|
|
|
1843
|
-
| Flag
|
|
1844
|
-
|
|
1845
|
-
| `-y, --yes` | Skip confirmation prompts
|
|
1846
|
-
| `--force`
|
|
1931
|
+
| Flag | Description |
|
|
1932
|
+
| ----------- | ------------------------------------------- |
|
|
1933
|
+
| `-y, --yes` | Skip confirmation prompts |
|
|
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
|
|
@@ -1860,11 +1949,12 @@ Update user roles in the organization. If no user ID provided, shows interactive
|
|
|
1860
1949
|
tigris iam users update-role [resource] [flags]
|
|
1861
1950
|
```
|
|
1862
1951
|
|
|
1863
|
-
| Flag
|
|
1864
|
-
|
|
1952
|
+
| Flag | Description |
|
|
1953
|
+
| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
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
|
|
@@ -1880,12 +1970,13 @@ Remove users from the organization. If no user ID provided, shows interactive se
|
|
|
1880
1970
|
tigris iam users remove [resource] [flags]
|
|
1881
1971
|
```
|
|
1882
1972
|
|
|
1883
|
-
| Flag
|
|
1884
|
-
|
|
1885
|
-
| `-y, --yes` | Skip confirmation prompts
|
|
1886
|
-
| `--force`
|
|
1973
|
+
| Flag | Description |
|
|
1974
|
+
| ----------- | ------------------------------------------- |
|
|
1975
|
+
| `-y, --yes` | Skip confirmation prompts |
|
|
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
|
|
@@ -1896,11 +1987,11 @@ tigris iam users remove user@example.com,user@example.net --yes
|
|
|
1896
1987
|
|
|
1897
1988
|
Manage organization teams
|
|
1898
1989
|
|
|
1899
|
-
| Command
|
|
1900
|
-
|
|
1901
|
-
| `tigris iam teams list` (l)
|
|
1902
|
-
| `tigris iam teams create` (c) | Create a new team in the organization
|
|
1903
|
-
| `tigris iam teams edit` (e)
|
|
1990
|
+
| Command | Description |
|
|
1991
|
+
| ----------------------------- | ------------------------------------------------------------------------------------------ |
|
|
1992
|
+
| `tigris iam teams list` (l) | List all teams in the organization |
|
|
1993
|
+
| `tigris iam teams create` (c) | Create a new team in the organization |
|
|
1994
|
+
| `tigris iam teams edit` (e) | Update a team's name, description, or members. Members are replaced with the provided list |
|
|
1904
1995
|
|
|
1905
1996
|
##### `tigris iam teams list` (l)
|
|
1906
1997
|
|
|
@@ -1910,11 +2001,12 @@ List all teams in the organization
|
|
|
1910
2001
|
tigris iam teams list [flags]
|
|
1911
2002
|
```
|
|
1912
2003
|
|
|
1913
|
-
| Flag
|
|
1914
|
-
|
|
2004
|
+
| Flag | Description |
|
|
2005
|
+
| ---------- | ------------------------------ |
|
|
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
|
|
@@ -1928,12 +2020,13 @@ Create a new team in the organization
|
|
|
1928
2020
|
tigris iam teams create <name> [flags]
|
|
1929
2021
|
```
|
|
1930
2022
|
|
|
1931
|
-
| Flag
|
|
1932
|
-
|
|
1933
|
-
| `-d, --description` | Description for the team
|
|
1934
|
-
| `-m, --members`
|
|
2023
|
+
| Flag | Description |
|
|
2024
|
+
| ------------------- | -------------------------------------------------------------- |
|
|
2025
|
+
| `-d, --description` | Description for the team |
|
|
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'
|
|
@@ -1948,13 +2041,14 @@ Update a team's name, description, or members. Members are replaced with the pro
|
|
|
1948
2041
|
tigris iam teams edit <id> [flags]
|
|
1949
2042
|
```
|
|
1950
2043
|
|
|
1951
|
-
| Flag
|
|
1952
|
-
|
|
1953
|
-
| `-n, --name`
|
|
1954
|
-
| `-d, --description` | New description for the team
|
|
1955
|
-
| `-m, --members`
|
|
2044
|
+
| Flag | Description |
|
|
2045
|
+
| ------------------- | -------------------------------------------------------------------------------------- |
|
|
2046
|
+
| `-n, --name` | New name for the team |
|
|
2047
|
+
| `-d, --description` | New description for the team |
|
|
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'
|
|
@@ -1975,6 +2069,26 @@ tigris telemetry enable
|
|
|
1975
2069
|
`TIGRIS_NO_TELEMETRY=1` or `DO_NOT_TRACK=1` also disable it and take precedence
|
|
1976
2070
|
over the stored setting. Telemetry is off in development builds and test runs.
|
|
1977
2071
|
|
|
2072
|
+
Usage analytics send one `cli_command` event per command, when it finishes.
|
|
2073
|
+
Besides the command, its scrubbed arguments, flag names, CLI and OS versions,
|
|
2074
|
+
install method and auth method, each event records the outcome:
|
|
2075
|
+
|
|
2076
|
+
| Property | Meaning |
|
|
2077
|
+
| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2078
|
+
| `success` | `true` when the command exited 0 |
|
|
2079
|
+
| `exit_code` | The process exit code (`130` for Ctrl-C) |
|
|
2080
|
+
| `duration_ms` | Time from dispatch to exit |
|
|
2081
|
+
| `error_category` | On failure: `auth`, `permission`, `not_found`, `rate_limit`, `network`, `general`, `usage` (rejected before any work, e.g. an unknown flag) or `interrupted` |
|
|
2082
|
+
| `error_code` | On failure, when the error carries one: a short machine code such as an S3 error name or `commander.unknownOption`. Never the error message |
|
|
2083
|
+
|
|
2084
|
+
The first event or login from a machine also records, once per person,
|
|
2085
|
+
`first_interface: cli`, `first_cli_install_method` and `first_cli_version`.
|
|
2086
|
+
|
|
2087
|
+
Commands never wait on telemetry: events and error reports are written to a
|
|
2088
|
+
private temp file and sent by a short-lived background copy of the CLI after
|
|
2089
|
+
the command exits (`tigris __telemetry-send` is that internal step, not a
|
|
2090
|
+
command to run yourself).
|
|
2091
|
+
|
|
1978
2092
|
## License
|
|
1979
2093
|
|
|
1980
2094
|
MIT
|