@tigrisdata/cli 3.17.1 → 3.17.2
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 +478 -458
- 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 +447 -448
- package/dist/chunk-36RAXRXY.js +1 -0
- package/dist/{chunk-M4JVQTPR.js → chunk-4BWK33XD.js} +1 -1
- package/dist/chunk-56W4QIZP.js +4 -0
- package/dist/{chunk-EYLDWSKA.js → chunk-5FFSAQBH.js} +1 -1
- package/dist/chunk-6R467XCM.js +1 -0
- package/dist/{chunk-VFFI5OXM.js → chunk-A6IZCL2R.js} +1 -1
- package/dist/{chunk-OUSR4REZ.js → chunk-H4VWRKBZ.js} +1 -1
- package/dist/{chunk-PMFE4543.js → chunk-JQRHEFN2.js} +1 -1
- package/dist/chunk-L5TE7GWK.js +1 -0
- package/dist/{chunk-EBZOJ2UO.js → chunk-QJKKFI5K.js} +1 -1
- package/dist/chunk-QJMLIBCG.js +8 -0
- package/dist/{chunk-H5EV2OLS.js → chunk-U63FQLE2.js} +1 -1
- package/dist/chunk-VI5JXLP7.js +1 -0
- package/dist/{chunk-RUJKMQPD.js → chunk-XCHHTO54.js} +1 -1
- package/dist/{chunk-MZ6PKN6C.js → chunk-YRVVZ64M.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 +298 -299
- package/dist/utils/analytics.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 +1 -1
- 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-2AC5S3JV.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,8 +70,8 @@ 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:**
|
|
@@ -89,11 +89,11 @@ Save access-key credentials to ~/.tigris/config.json for persistent use across a
|
|
|
89
89
|
tigris configure [flags]
|
|
90
90
|
```
|
|
91
91
|
|
|
92
|
-
| Flag
|
|
93
|
-
|
|
94
|
-
| `-key, --access-key`
|
|
95
|
-
| `-secret, --access-secret` | Your Tigris secret access key
|
|
96
|
-
| `-e, --endpoint`
|
|
92
|
+
| Flag | Description |
|
|
93
|
+
| -------------------------- | ----------------------------------------------------- |
|
|
94
|
+
| `-key, --access-key` | Your Tigris access key ID |
|
|
95
|
+
| `-secret, --access-secret` | Your Tigris secret access key |
|
|
96
|
+
| `-e, --endpoint` | Tigris API endpoint (default: https://t3.storage.dev) |
|
|
97
97
|
|
|
98
98
|
**Examples:**
|
|
99
99
|
```bash
|
|
@@ -105,10 +105,10 @@ tigris configure --endpoint https://custom.endpoint.dev
|
|
|
105
105
|
|
|
106
106
|
Start a session via OAuth (default) or temporary credentials. Session state is cleared on logout
|
|
107
107
|
|
|
108
|
-
| Command
|
|
109
|
-
|
|
110
|
-
| `tigris login select`
|
|
111
|
-
| `tigris login oauth` (o)
|
|
108
|
+
| Command | Description |
|
|
109
|
+
| ------------------------------ | ------------------------------------------------------------------------------------------ |
|
|
110
|
+
| `tigris login select` | Choose how to login - OAuth (browser) or credentials (access key) |
|
|
111
|
+
| `tigris login oauth` (o) | Login via browser using OAuth2 device flow. Best for interactive use |
|
|
112
112
|
| `tigris login credentials` (c) | Login with an access key and secret. Creates a temporary session that is cleared on logout |
|
|
113
113
|
|
|
114
114
|
#### `tigris login select`
|
|
@@ -140,9 +140,9 @@ Login with an access key and secret. Creates a temporary session that is cleared
|
|
|
140
140
|
tigris login credentials [flags]
|
|
141
141
|
```
|
|
142
142
|
|
|
143
|
-
| Flag
|
|
144
|
-
|
|
145
|
-
| `-key, --access-key`
|
|
143
|
+
| Flag | Description |
|
|
144
|
+
| -------------------------- | ---------------------------------------------------- |
|
|
145
|
+
| `-key, --access-key` | Your access key ID (will prompt if not provided) |
|
|
146
146
|
| `-secret, --access-secret` | Your secret access key (will prompt if not provided) |
|
|
147
147
|
|
|
148
148
|
**Examples:**
|
|
@@ -172,11 +172,11 @@ Show the active organization's usage and charges for a billing month, as on the
|
|
|
172
172
|
tigris usage [flags]
|
|
173
173
|
```
|
|
174
174
|
|
|
175
|
-
| Flag
|
|
176
|
-
|
|
177
|
-
| `--month`
|
|
178
|
-
| `--all`
|
|
179
|
-
| `--format` | Output format (default: table)
|
|
175
|
+
| Flag | Description |
|
|
176
|
+
| ---------- | ------------------------------------------------------- |
|
|
177
|
+
| `--month` | Billing month as YYYY-MM (default is the current month) |
|
|
178
|
+
| `--all` | Show every line item, even those with zero usage |
|
|
179
|
+
| `--format` | Output format (default: table) |
|
|
180
180
|
|
|
181
181
|
**Examples:**
|
|
182
182
|
```bash
|
|
@@ -216,8 +216,8 @@ tigris logout
|
|
|
216
216
|
|
|
217
217
|
Test whether your current credentials can reach Tigris and optionally verify access to a specific bucket
|
|
218
218
|
|
|
219
|
-
| Command
|
|
220
|
-
|
|
219
|
+
| Command | Description |
|
|
220
|
+
| ----------------------------- | ---------------------------------------------------------------------------------------- |
|
|
221
221
|
| `tigris credentials test` (t) | Verify that current credentials are valid. Optionally checks access to a specific bucket |
|
|
222
222
|
|
|
223
223
|
#### `tigris credentials test` (t)
|
|
@@ -228,8 +228,8 @@ Verify that current credentials are valid. Optionally checks access to a specifi
|
|
|
228
228
|
tigris credentials test [flags]
|
|
229
229
|
```
|
|
230
230
|
|
|
231
|
-
| Flag
|
|
232
|
-
|
|
231
|
+
| Flag | Description |
|
|
232
|
+
| -------------- | --------------------------------------------- |
|
|
233
233
|
| `-b, --bucket` | Bucket name to test access against (optional) |
|
|
234
234
|
|
|
235
235
|
**Examples:**
|
|
@@ -242,11 +242,11 @@ tigris credentials test --bucket my-bucket
|
|
|
242
242
|
|
|
243
243
|
Show or change whether the CLI sends usage analytics and error reports
|
|
244
244
|
|
|
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`
|
|
245
|
+
| Command | Description |
|
|
246
|
+
| -------------------------- | ------------------------------------------------------------------------------------ |
|
|
247
|
+
| `tigris telemetry status` | Show whether telemetry is enabled, what is collected, and which setting is in effect |
|
|
248
|
+
| `tigris telemetry disable` | Turn off usage analytics and error reports on this machine |
|
|
249
|
+
| `tigris telemetry enable` | Turn usage analytics and error reports back on for this machine |
|
|
250
250
|
|
|
251
251
|
#### `tigris telemetry status`
|
|
252
252
|
|
|
@@ -295,13 +295,13 @@ List all buckets (no arguments) or objects under a bucket/prefix path. Accepts b
|
|
|
295
295
|
tigris ls [path] [flags]
|
|
296
296
|
```
|
|
297
297
|
|
|
298
|
-
| Flag
|
|
299
|
-
|
|
298
|
+
| Flag | Description |
|
|
299
|
+
| ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
300
300
|
| `-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`
|
|
301
|
+
| `--format` | Output format (default: table) |
|
|
302
|
+
| `--limit` | Maximum number of items to return per page |
|
|
303
|
+
| `-pt, --page-token` | Pagination token from a previous request to fetch the next page |
|
|
304
|
+
| `--source` | List objects from a specific storage source on buckets with shadow migration enabled |
|
|
305
305
|
|
|
306
306
|
**Examples:**
|
|
307
307
|
```bash
|
|
@@ -319,16 +319,16 @@ Create a bucket (bare name) or a folder inside a bucket (bucket/folder/ with tra
|
|
|
319
319
|
tigris mk <path> [flags]
|
|
320
320
|
```
|
|
321
321
|
|
|
322
|
-
| Flag
|
|
323
|
-
|
|
324
|
-
| `-a, --access`
|
|
325
|
-
| `--public`
|
|
326
|
-
| `-s, --enable-snapshots`
|
|
327
|
-
| `--allow-object-acl`
|
|
328
|
-
| `--enable-directory-listing`
|
|
329
|
-
| `-t, --default-tier`
|
|
330
|
-
| `-l, --locations`
|
|
331
|
-
| `-fork, --fork-of`
|
|
322
|
+
| Flag | Description |
|
|
323
|
+
| --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
324
|
+
| `-a, --access` | Access level (only applies when creating a bucket) (default: private) |
|
|
325
|
+
| `--public` | Shorthand for --access public (only applies when creating a bucket) |
|
|
326
|
+
| `-s, --enable-snapshots` | Enable snapshots for the bucket (only applies when creating a bucket) (default: false) |
|
|
327
|
+
| `--allow-object-acl` | Allow per-object ACLs on the bucket (only applies when creating a bucket) (default: false) |
|
|
328
|
+
| `--enable-directory-listing` | Enable directory listing, relevant for public buckets (only applies when creating a bucket) (default: false) |
|
|
329
|
+
| `-t, --default-tier` | Default storage tier (only applies when creating a bucket) (default: STANDARD) |
|
|
330
|
+
| `-l, --locations` | Location for the bucket (only applies when creating a bucket) (default: global) |
|
|
331
|
+
| `-fork, --fork-of` | Create this bucket as a fork (copy-on-write clone) of the named source bucket |
|
|
332
332
|
| `-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
333
|
|
|
334
334
|
**Examples:**
|
|
@@ -365,11 +365,11 @@ Show storage stats (no args), bucket info, or object metadata
|
|
|
365
365
|
tigris stat [path] [flags]
|
|
366
366
|
```
|
|
367
367
|
|
|
368
|
-
| Flag
|
|
369
|
-
|
|
370
|
-
| `--format`
|
|
368
|
+
| Flag | Description |
|
|
369
|
+
| ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
370
|
+
| `--format` | Output format (default: table) |
|
|
371
371
|
| `-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`
|
|
372
|
+
| `--version-id` | Object version id to stat (requires bucket versioning). Omit to stat the latest version |
|
|
373
373
|
|
|
374
374
|
**Examples:**
|
|
375
375
|
```bash
|
|
@@ -386,13 +386,13 @@ Generate a presigned URL for temporary access to an object without credentials
|
|
|
386
386
|
tigris presign <path> [flags]
|
|
387
387
|
```
|
|
388
388
|
|
|
389
|
-
| Flag
|
|
390
|
-
|
|
391
|
-
| `-m, --method`
|
|
392
|
-
| `-e, --expires-in`
|
|
393
|
-
| `--access-key`
|
|
394
|
-
| `--select`
|
|
395
|
-
| `--format`
|
|
389
|
+
| Flag | Description |
|
|
390
|
+
| ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
391
|
+
| `-m, --method` | HTTP method for the presigned URL (default: get) |
|
|
392
|
+
| `-e, --expires-in` | URL expiry time in seconds (default: 3600) |
|
|
393
|
+
| `--access-key` | Access key ID to use for signing. If not provided, resolved from credentials or auto-selected |
|
|
394
|
+
| `--select` | Interactively select an access key (OAuth only) |
|
|
395
|
+
| `--format` | Output format (default: url) |
|
|
396
396
|
| `-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
397
|
|
|
398
398
|
**Examples:**
|
|
@@ -411,10 +411,10 @@ Copy files between local filesystem and Tigris, or between paths within Tigris.
|
|
|
411
411
|
tigris cp <src> <dest> [flags]
|
|
412
412
|
```
|
|
413
413
|
|
|
414
|
-
| Flag
|
|
415
|
-
|
|
416
|
-
| `-r, --recursive` | Copy directories recursively
|
|
417
|
-
| `-a, --access`
|
|
414
|
+
| Flag | Description |
|
|
415
|
+
| ----------------- | ------------------------------------------------------------------------------------------- |
|
|
416
|
+
| `-r, --recursive` | Copy directories recursively |
|
|
417
|
+
| `-a, --access` | Access level for uploaded objects (only applies to local-to-remote uploads) |
|
|
418
418
|
| `--cache-control` | Cache-Control header stored with uploaded objects (only applies to local-to-remote uploads) |
|
|
419
419
|
|
|
420
420
|
**Examples:**
|
|
@@ -435,11 +435,11 @@ Move (rename) objects within Tigris. Both source and destination must be remote
|
|
|
435
435
|
tigris mv <src> <dest> [flags]
|
|
436
436
|
```
|
|
437
437
|
|
|
438
|
-
| Flag
|
|
439
|
-
|
|
440
|
-
| `-y, --yes`
|
|
441
|
-
| `-r, --recursive` | Move directories recursively
|
|
442
|
-
| `-f, --force`
|
|
438
|
+
| Flag | Description |
|
|
439
|
+
| ----------------- | ------------------------------------------- |
|
|
440
|
+
| `-y, --yes` | Skip confirmation prompts |
|
|
441
|
+
| `-r, --recursive` | Move directories recursively |
|
|
442
|
+
| `-f, --force` | Skip confirmation prompts (alias for --yes) |
|
|
443
443
|
|
|
444
444
|
**Examples:**
|
|
445
445
|
```bash
|
|
@@ -456,11 +456,11 @@ Remove a bucket, folder, or object from Tigris. A bare bucket name deletes the b
|
|
|
456
456
|
tigris rm <path> [flags]
|
|
457
457
|
```
|
|
458
458
|
|
|
459
|
-
| Flag
|
|
460
|
-
|
|
461
|
-
| `-y, --yes`
|
|
462
|
-
| `-r, --recursive` | Remove directories recursively
|
|
463
|
-
| `-f, --force`
|
|
459
|
+
| Flag | Description |
|
|
460
|
+
| ----------------- | ------------------------------------------- |
|
|
461
|
+
| `-y, --yes` | Skip confirmation prompts |
|
|
462
|
+
| `-r, --recursive` | Remove directories recursively |
|
|
463
|
+
| `-f, --force` | Skip confirmation prompts (alias for --yes) |
|
|
464
464
|
|
|
465
465
|
**Examples:**
|
|
466
466
|
```bash
|
|
@@ -478,12 +478,12 @@ Download multiple objects as a streaming tar archive in a single request. Design
|
|
|
478
478
|
tigris bundle <bucket> [flags]
|
|
479
479
|
```
|
|
480
480
|
|
|
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`
|
|
481
|
+
| Flag | Description |
|
|
482
|
+
| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
483
|
+
| `-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 |
|
|
484
|
+
| `-o, --output` | Output file path. Defaults to stdout (for piping) |
|
|
485
|
+
| `--compression` | Compression algorithm for the archive. Auto-detected from output file extension when not specified |
|
|
486
|
+
| `--on-error` | How to handle missing objects. 'skip' omits them, 'fail' aborts the request (default: skip) |
|
|
487
487
|
|
|
488
488
|
**Examples:**
|
|
489
489
|
```bash
|
|
@@ -497,11 +497,11 @@ cat keys.txt | tigris bundle my-bucket > archive.tar
|
|
|
497
497
|
|
|
498
498
|
List, create, and switch between organizations. An organization is a workspace that contains your resources like buckets and access keys
|
|
499
499
|
|
|
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
|
|
500
|
+
| Command | Description |
|
|
501
|
+
| --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
502
|
+
| `tigris organizations list` (l) | List all organizations you belong to and interactively select one as active |
|
|
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 |
|
|
505
505
|
| `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
506
|
|
|
507
507
|
#### `tigris organizations list` (l)
|
|
@@ -512,10 +512,10 @@ List all organizations you belong to and interactively select one as active
|
|
|
512
512
|
tigris organizations list [flags]
|
|
513
513
|
```
|
|
514
514
|
|
|
515
|
-
| Flag
|
|
516
|
-
|
|
517
|
-
| `--format`
|
|
518
|
-
| `-i, --select` | Interactive selection mode
|
|
515
|
+
| Flag | Description |
|
|
516
|
+
| -------------- | ------------------------------- |
|
|
517
|
+
| `--format` | Output format (default: select) |
|
|
518
|
+
| `-i, --select` | Interactive selection mode |
|
|
519
519
|
|
|
520
520
|
**Examples:**
|
|
521
521
|
```bash
|
|
@@ -557,8 +557,8 @@ Delete an organization you own, picked from a list or given by ID. It must be em
|
|
|
557
557
|
tigris organizations delete [id] [flags]
|
|
558
558
|
```
|
|
559
559
|
|
|
560
|
-
| Flag
|
|
561
|
-
|
|
560
|
+
| Flag | Description |
|
|
561
|
+
| ----------- | ------------------------- |
|
|
562
562
|
| `-y, --yes` | Skip confirmation prompts |
|
|
563
563
|
|
|
564
564
|
**Examples:**
|
|
@@ -571,26 +571,26 @@ tigris orgs delete <org-id> --yes
|
|
|
571
571
|
|
|
572
572
|
Create, inspect, update, and delete buckets. Buckets are top-level containers that hold objects
|
|
573
573
|
|
|
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`
|
|
574
|
+
| Command | Description |
|
|
575
|
+
| ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
576
|
+
| `tigris buckets list` (l) | List all buckets in the current organization |
|
|
577
|
+
| `tigris buckets create` (c) | Create a new bucket with optional access, tier, and location settings |
|
|
578
|
+
| `tigris buckets rebase` | Update a fork with the latest changes from its source bucket |
|
|
579
|
+
| `tigris buckets merge` | Merge a fork's changes back into its source bucket |
|
|
580
|
+
| `tigris buckets get` (g) | Show details for a bucket including access level, region, tier, and custom domain |
|
|
581
|
+
| `tigris buckets delete` (d) | Delete one or more buckets by name. The bucket must be empty or delete-protection must be off |
|
|
582
|
+
| `tigris buckets restore` | Restore a soft-deleted bucket within its retention window. List recoverable buckets with "tigris buckets list --deleted" |
|
|
583
|
+
| `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" |
|
|
584
|
+
| `tigris buckets set` (s) | Update settings on an existing bucket such as access level, default tier, location, caching, or custom domain |
|
|
585
|
+
| `tigris buckets enable-snapshots` | Enable snapshots on an existing bucket, converting it to a snapshot bucket |
|
|
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` | Set the data locations for a bucket |
|
|
588
|
+
| `tigris buckets set-migration` | Configure data migration from an external S3-compatible source bucket. Tigris will pull objects on demand from the source |
|
|
589
|
+
| `tigris buckets migrate` | Actively migrate all objects from a shadow bucket to Tigris by scheduling server-side migration for unmigrated objects |
|
|
590
|
+
| `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 |
|
|
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` | Configure CORS rules on a bucket. Each invocation adds a rule unless --override or --reset is used |
|
|
593
|
+
| `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
594
|
|
|
595
595
|
#### `tigris buckets list` (l)
|
|
596
596
|
|
|
@@ -600,15 +600,15 @@ List all buckets in the current organization
|
|
|
600
600
|
tigris buckets list [flags]
|
|
601
601
|
```
|
|
602
602
|
|
|
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
|
|
603
|
+
| Flag | Description |
|
|
604
|
+
| ------------------- | -------------------------------------------------------------------- |
|
|
605
|
+
| `--format` | Output format (default: table) |
|
|
606
|
+
| `--forks-of` | Only list buckets that are forks of the named source bucket |
|
|
607
|
+
| `--deleted` | Only list soft-deleted buckets |
|
|
608
|
+
| `--forks-only` | Only list buckets that are forks of another bucket |
|
|
609
|
+
| `--owner` | Only list buckets owned by this user, by username (an email address) |
|
|
610
|
+
| `--limit` | Maximum number of items to return per page |
|
|
611
|
+
| `-pt, --page-token` | Pagination token from a previous request to fetch the next page |
|
|
612
612
|
|
|
613
613
|
**Examples:**
|
|
614
614
|
```bash
|
|
@@ -628,16 +628,16 @@ Create a new bucket with optional access, tier, and location settings
|
|
|
628
628
|
tigris buckets create [name] [flags]
|
|
629
629
|
```
|
|
630
630
|
|
|
631
|
-
| Flag
|
|
632
|
-
|
|
633
|
-
| `-a, --access`
|
|
634
|
-
| `--public`
|
|
635
|
-
| `-s, --enable-snapshots`
|
|
636
|
-
| `--allow-object-acl`
|
|
637
|
-
| `--enable-directory-listing`
|
|
638
|
-
| `-t, --default-tier`
|
|
639
|
-
| `-l, --locations`
|
|
640
|
-
| `-fork, --fork-of`
|
|
631
|
+
| Flag | Description |
|
|
632
|
+
| --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
633
|
+
| `-a, --access` | Access level (default: private) |
|
|
634
|
+
| `--public` | Shorthand for --access public |
|
|
635
|
+
| `-s, --enable-snapshots` | Enable snapshots for the bucket (default: false) |
|
|
636
|
+
| `--allow-object-acl` | Allow per-object ACLs on the bucket (default: false) |
|
|
637
|
+
| `--enable-directory-listing` | Enable directory listing, relevant for public buckets (default: false) |
|
|
638
|
+
| `-t, --default-tier` | Choose the default tier for the bucket (default: STANDARD) |
|
|
639
|
+
| `-l, --locations` | Location for the bucket (default: global) |
|
|
640
|
+
| `-fork, --fork-of` | Create this bucket as a fork (copy-on-write clone) of the named source bucket |
|
|
641
641
|
| `-source-snap, --source-snapshot` | Fork from a specific snapshot of the source bucket. Accepts a snapshot version string or any UNIX nanosecond-precision timestamp (e.g. 1765889000501544464). Requires --fork-of |
|
|
642
642
|
|
|
643
643
|
**Examples:**
|
|
@@ -659,8 +659,8 @@ Update a fork with the latest changes from its source bucket
|
|
|
659
659
|
tigris buckets rebase <fork> [flags]
|
|
660
660
|
```
|
|
661
661
|
|
|
662
|
-
| Flag
|
|
663
|
-
|
|
662
|
+
| Flag | Description |
|
|
663
|
+
| ----------- | ------------------------- |
|
|
664
664
|
| `-y, --yes` | Skip confirmation prompts |
|
|
665
665
|
|
|
666
666
|
**Examples:**
|
|
@@ -677,10 +677,10 @@ Merge a fork's changes back into its source bucket
|
|
|
677
677
|
tigris buckets merge <fork> [flags]
|
|
678
678
|
```
|
|
679
679
|
|
|
680
|
-
| Flag
|
|
681
|
-
|
|
682
|
-
| `-y, --yes`
|
|
683
|
-
| `-source, --into`
|
|
680
|
+
| Flag | Description |
|
|
681
|
+
| ----------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
682
|
+
| `-y, --yes` | Skip confirmation prompts |
|
|
683
|
+
| `-source, --into` | Source bucket to merge into. Defaults to the fork's parent source bucket |
|
|
684
684
|
| `-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
685
|
|
|
686
686
|
**Examples:**
|
|
@@ -699,8 +699,8 @@ Show details for a bucket including access level, region, tier, and custom domai
|
|
|
699
699
|
tigris buckets get <name> [flags]
|
|
700
700
|
```
|
|
701
701
|
|
|
702
|
-
| Flag
|
|
703
|
-
|
|
702
|
+
| Flag | Description |
|
|
703
|
+
| ---------- | ------------------------------ |
|
|
704
704
|
| `--format` | Output format (default: table) |
|
|
705
705
|
|
|
706
706
|
**Examples:**
|
|
@@ -716,10 +716,10 @@ Delete one or more buckets by name. The bucket must be empty or delete-protectio
|
|
|
716
716
|
tigris buckets delete <name> [flags]
|
|
717
717
|
```
|
|
718
718
|
|
|
719
|
-
| Flag
|
|
720
|
-
|
|
721
|
-
| `-y, --yes` | Skip confirmation prompts
|
|
722
|
-
| `--force`
|
|
719
|
+
| Flag | Description |
|
|
720
|
+
| ----------- | ------------------------------------------- |
|
|
721
|
+
| `-y, --yes` | Skip confirmation prompts |
|
|
722
|
+
| `--force` | Skip confirmation prompts (alias for --yes) |
|
|
723
723
|
|
|
724
724
|
**Examples:**
|
|
725
725
|
```bash
|
|
@@ -748,10 +748,10 @@ Permanently destroy one or more soft-deleted buckets before their retention peri
|
|
|
748
748
|
tigris buckets purge <name> [flags]
|
|
749
749
|
```
|
|
750
750
|
|
|
751
|
-
| Flag
|
|
752
|
-
|
|
753
|
-
| `-y, --yes` | Skip confirmation prompts
|
|
754
|
-
| `--force`
|
|
751
|
+
| Flag | Description |
|
|
752
|
+
| ----------- | ------------------------------------------- |
|
|
753
|
+
| `-y, --yes` | Skip confirmation prompts |
|
|
754
|
+
| `--force` | Skip confirmation prompts (alias for --yes) |
|
|
755
755
|
|
|
756
756
|
**Examples:**
|
|
757
757
|
```bash
|
|
@@ -767,19 +767,19 @@ Update settings on an existing bucket such as access level, default tier, locati
|
|
|
767
767
|
tigris buckets set <name> [flags]
|
|
768
768
|
```
|
|
769
769
|
|
|
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)
|
|
770
|
+
| Flag | Description |
|
|
771
|
+
| ----------------------------- | -------------------------------------------------------------------------------------------- |
|
|
772
|
+
| `--access` | Bucket access level |
|
|
773
|
+
| `--default-tier` | Change the default storage tier for objects uploaded to the bucket |
|
|
774
|
+
| `--locations` | Bucket location (see https://www.tigrisdata.com/docs/buckets/locations/ for more details) |
|
|
775
|
+
| `--allow-object-acl` | Enable object-level ACL |
|
|
776
|
+
| `--disable-directory-listing` | Disable directory listing |
|
|
777
|
+
| `--cache-control` | Default cache-control header value |
|
|
778
|
+
| `--custom-domain` | Custom domain for the bucket |
|
|
779
|
+
| `--enable-delete-protection` | Enable delete protection |
|
|
780
|
+
| `--soft-delete` | Enable or disable soft delete (recoverable deletes). Requires --retention-days when enabling |
|
|
781
|
+
| `--retention-days` | Number of days to retain soft-deleted objects (required when enabling --soft-delete) |
|
|
782
|
+
| `--enable-additional-headers` | Enable additional HTTP headers (X-Content-Type-Options nosniff) |
|
|
783
783
|
|
|
784
784
|
**Examples:**
|
|
785
785
|
```bash
|
|
@@ -825,8 +825,8 @@ Set the data locations for a bucket
|
|
|
825
825
|
tigris buckets set-locations <name> [flags]
|
|
826
826
|
```
|
|
827
827
|
|
|
828
|
-
| Flag
|
|
829
|
-
|
|
828
|
+
| Flag | Description |
|
|
829
|
+
| ----------------- | --------------- |
|
|
830
830
|
| `-l, --locations` | Bucket location |
|
|
831
831
|
|
|
832
832
|
**Examples:**
|
|
@@ -844,15 +844,15 @@ Configure data migration from an external S3-compatible source bucket. Tigris wi
|
|
|
844
844
|
tigris buckets set-migration <name> [flags]
|
|
845
845
|
```
|
|
846
846
|
|
|
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
|
-
| `--disable`
|
|
847
|
+
| Flag | Description |
|
|
848
|
+
| ----------------------- | --------------------------------------------------------------- |
|
|
849
|
+
| `-b, --bucket` | Name of the source bucket to migrate from |
|
|
850
|
+
| `-e, --endpoint` | Endpoint URL of the source S3-compatible service |
|
|
851
|
+
| `-r, --region` | Region of the source bucket |
|
|
852
|
+
| `-key, --access-key` | Access key for the source bucket |
|
|
853
|
+
| `-secret, --secret-key` | Secret key for the source bucket |
|
|
854
|
+
| `--write-through` | Enable write-through mode (writes go to both source and Tigris) |
|
|
855
|
+
| `--disable` | Disable migration and clear all migration settings |
|
|
856
856
|
|
|
857
857
|
**Examples:**
|
|
858
858
|
```bash
|
|
@@ -869,8 +869,8 @@ Actively migrate all objects from a shadow bucket to Tigris by scheduling server
|
|
|
869
869
|
tigris buckets migrate <path> [flags]
|
|
870
870
|
```
|
|
871
871
|
|
|
872
|
-
| Flag
|
|
873
|
-
|
|
872
|
+
| Flag | Description |
|
|
873
|
+
| -------------------- | ---------------------------------------------------------------------------------------------------------- |
|
|
874
874
|
| `--max-in-flight-gb` | Max total gigabytes of scheduled-but-unconfirmed migrations to keep in flight. Accepts 1-100 (default: 50) |
|
|
875
875
|
|
|
876
876
|
**Examples:**
|
|
@@ -885,11 +885,11 @@ tigris buckets migrate my-bucket --max-in-flight-gb 100
|
|
|
885
885
|
|
|
886
886
|
Manage bucket lifecycle rules. Each rule combines an optional storage-class transition and/or expiration (TTL), scoped to an optional key prefix
|
|
887
887
|
|
|
888
|
-
| Command
|
|
889
|
-
|
|
890
|
-
| `tigris buckets lifecycle list` (l)
|
|
888
|
+
| Command | Description |
|
|
889
|
+
| ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
890
|
+
| `tigris buckets lifecycle list` (l) | List lifecycle rules on a bucket |
|
|
891
891
|
| `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)
|
|
892
|
+
| `tigris buckets lifecycle edit` (e) | Edit an existing lifecycle rule by its id. Only specified fields are changed |
|
|
893
893
|
|
|
894
894
|
##### `tigris buckets lifecycle list` (l)
|
|
895
895
|
|
|
@@ -899,8 +899,8 @@ List lifecycle rules on a bucket
|
|
|
899
899
|
tigris buckets lifecycle list <name> [flags]
|
|
900
900
|
```
|
|
901
901
|
|
|
902
|
-
| Flag
|
|
903
|
-
|
|
902
|
+
| Flag | Description |
|
|
903
|
+
| ---------- | ------------------------------ |
|
|
904
904
|
| `--format` | Output format (default: table) |
|
|
905
905
|
|
|
906
906
|
**Examples:**
|
|
@@ -917,15 +917,15 @@ Create a new lifecycle rule. A rule must include a transition (--storage-class w
|
|
|
917
917
|
tigris buckets lifecycle create <name> [flags]
|
|
918
918
|
```
|
|
919
919
|
|
|
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`
|
|
920
|
+
| Flag | Description |
|
|
921
|
+
| --------------------- | --------------------------------------------------------------------------------------- |
|
|
922
|
+
| `-p, --prefix` | Key prefix to scope the rule to. Omit for a bucket-wide rule |
|
|
923
|
+
| `-s, --storage-class` | Target storage class for the transition |
|
|
924
|
+
| `-d, --days` | Transition objects after this many days (used with --storage-class) |
|
|
925
|
+
| `--date` | Transition objects on this date (ISO-8601, e.g. 2026-06-01) (used with --storage-class) |
|
|
926
|
+
| `--expire-days` | Expire (delete) objects after this many days |
|
|
927
|
+
| `--expire-date` | Expire (delete) objects on this date (ISO-8601, e.g. 2026-06-01) |
|
|
928
|
+
| `--disable` | Create the rule in a disabled state |
|
|
929
929
|
|
|
930
930
|
**Examples:**
|
|
931
931
|
```bash
|
|
@@ -943,16 +943,16 @@ Edit an existing lifecycle rule by its id. Only specified fields are changed
|
|
|
943
943
|
tigris buckets lifecycle edit <name> <id> [flags]
|
|
944
944
|
```
|
|
945
945
|
|
|
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`
|
|
946
|
+
| Flag | Description |
|
|
947
|
+
| --------------------- | --------------------------------------------- |
|
|
948
|
+
| `-p, --prefix` | Replace the rule's key prefix |
|
|
949
|
+
| `-s, --storage-class` | Replace the rule's transition target |
|
|
950
|
+
| `-d, --days` | Replace the rule's transition days |
|
|
951
|
+
| `--date` | Replace the rule's transition date (ISO-8601) |
|
|
952
|
+
| `--expire-days` | Replace the rule's expiration days |
|
|
953
|
+
| `--expire-date` | Replace the rule's expiration date (ISO-8601) |
|
|
954
|
+
| `--enable` | Enable the rule |
|
|
955
|
+
| `--disable` | Disable the rule (does not remove it) |
|
|
956
956
|
|
|
957
957
|
**Examples:**
|
|
958
958
|
```bash
|
|
@@ -969,16 +969,16 @@ Configure object event notifications on a bucket. Sends webhook requests to a UR
|
|
|
969
969
|
tigris buckets set-notifications <name> [flags]
|
|
970
970
|
```
|
|
971
971
|
|
|
972
|
-
| Flag
|
|
973
|
-
|
|
974
|
-
| `-u, --url`
|
|
972
|
+
| Flag | Description |
|
|
973
|
+
| -------------- | ---------------------------------------------------------------------------- |
|
|
974
|
+
| `-u, --url` | Webhook URL to send notifications to (must be http or https) |
|
|
975
975
|
| `-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`
|
|
976
|
+
| `-t, --token` | Token for webhook authentication |
|
|
977
|
+
| `--username` | Username for basic webhook authentication |
|
|
978
|
+
| `--password` | Password for basic webhook authentication |
|
|
979
|
+
| `--enable` | Enable notifications on the bucket (uses existing config) |
|
|
980
|
+
| `--disable` | Disable notifications on the bucket (preserves existing config) |
|
|
981
|
+
| `--reset` | Clear all notification settings on the bucket |
|
|
982
982
|
|
|
983
983
|
**Examples:**
|
|
984
984
|
```bash
|
|
@@ -999,15 +999,15 @@ Configure CORS rules on a bucket. Each invocation adds a rule unless --override
|
|
|
999
999
|
tigris buckets set-cors <name> [flags]
|
|
1000
1000
|
```
|
|
1001
1001
|
|
|
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`
|
|
1002
|
+
| Flag | Description |
|
|
1003
|
+
| ------------------ | --------------------------------------------------------- |
|
|
1004
|
+
| `-o, --origins` | Allowed origins (comma-separated, or '*' for all) |
|
|
1005
|
+
| `-m, --methods` | Allowed HTTP methods (comma-separated, e.g. GET,POST,PUT) |
|
|
1006
|
+
| `--headers` | Allowed request headers (comma-separated, or '*' for all) |
|
|
1007
|
+
| `--expose-headers` | Response headers to expose (comma-separated) |
|
|
1008
|
+
| `--max-age` | Preflight cache duration in seconds (default: 3600) |
|
|
1009
|
+
| `--override` | Replace all existing CORS rules instead of appending |
|
|
1010
|
+
| `--reset` | Clear all CORS rules on the bucket |
|
|
1011
1011
|
|
|
1012
1012
|
**Examples:**
|
|
1013
1013
|
```bash
|
|
@@ -1025,14 +1025,14 @@ Share a bucket with your whole organization, specific teams, or specific users.
|
|
|
1025
1025
|
tigris buckets share <name> [flags]
|
|
1026
1026
|
```
|
|
1027
1027
|
|
|
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`
|
|
1028
|
+
| Flag | Description |
|
|
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` | Team ID to share with (can specify multiple, comma-separated). Each team is paired positionally with a --role value |
|
|
1032
|
+
| `-u, --user` | User ID to share with (can specify multiple, comma-separated). Each user is paired positionally with a --role value |
|
|
1033
|
+
| `-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 |
|
|
1034
|
+
| `--override` | Replace all existing shares instead of merging with them |
|
|
1035
|
+
| `--reset` | Remove all shares from the bucket |
|
|
1036
1036
|
|
|
1037
1037
|
**Examples:**
|
|
1038
1038
|
```bash
|
|
@@ -1048,10 +1048,10 @@ tigris buckets share my-bucket --reset
|
|
|
1048
1048
|
|
|
1049
1049
|
List, take, and delete snapshots. A snapshot is a point-in-time, read-only copy of a bucket's state
|
|
1050
1050
|
|
|
1051
|
-
| Command
|
|
1052
|
-
|
|
1053
|
-
| `tigris snapshots list` (l)
|
|
1054
|
-
| `tigris snapshots take` (t)
|
|
1051
|
+
| Command | Description |
|
|
1052
|
+
| ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
|
|
1053
|
+
| `tigris snapshots list` (l) | List all snapshots for the given bucket, ordered by creation time |
|
|
1054
|
+
| `tigris snapshots take` (t) | Take a new snapshot of the bucket's current state. Optionally provide a name for the snapshot |
|
|
1055
1055
|
| `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
1056
|
|
|
1057
1057
|
#### `tigris snapshots list` (l)
|
|
@@ -1062,10 +1062,10 @@ List all snapshots for the given bucket, ordered by creation time
|
|
|
1062
1062
|
tigris snapshots list <name> [flags]
|
|
1063
1063
|
```
|
|
1064
1064
|
|
|
1065
|
-
| Flag
|
|
1066
|
-
|
|
1067
|
-
| `--format`
|
|
1068
|
-
| `--limit`
|
|
1065
|
+
| Flag | Description |
|
|
1066
|
+
| ------------------- | --------------------------------------------------------------- |
|
|
1067
|
+
| `--format` | Output format (default: table) |
|
|
1068
|
+
| `--limit` | Maximum number of items to return per page |
|
|
1069
1069
|
| `-pt, --page-token` | Pagination token from a previous request to fetch the next page |
|
|
1070
1070
|
|
|
1071
1071
|
**Examples:**
|
|
@@ -1096,10 +1096,10 @@ Delete one or more snapshots of a bucket by version. Deletion is permanent; fork
|
|
|
1096
1096
|
tigris snapshots delete <name> <version> [flags]
|
|
1097
1097
|
```
|
|
1098
1098
|
|
|
1099
|
-
| Flag
|
|
1100
|
-
|
|
1101
|
-
| `-y, --yes` | Skip confirmation prompts
|
|
1102
|
-
| `--force`
|
|
1099
|
+
| Flag | Description |
|
|
1100
|
+
| ----------- | ------------------------------------------- |
|
|
1101
|
+
| `-y, --yes` | Skip confirmation prompts |
|
|
1102
|
+
| `--force` | Skip confirmation prompts (alias for --yes) |
|
|
1103
1103
|
|
|
1104
1104
|
**Examples:**
|
|
1105
1105
|
```bash
|
|
@@ -1111,20 +1111,20 @@ tigris snapshots delete my-bucket 1765889000501544464,1765889000501544465 --yes
|
|
|
1111
1111
|
|
|
1112
1112
|
Low-level object operations for listing, downloading, uploading, and deleting individual objects in a bucket
|
|
1113
1113
|
|
|
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)
|
|
1114
|
+
| Command | Description |
|
|
1115
|
+
| ------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1116
|
+
| `tigris objects list` (l) | List objects in a bucket, optionally filtered by a key prefix |
|
|
1117
|
+
| `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 |
|
|
1118
|
+
| `tigris objects get` (g) | Download an object by key. Prints to stdout by default, or saves to a file with --output |
|
|
1119
|
+
| `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 |
|
|
1120
|
+
| `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 |
|
|
1121
|
+
| `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 |
|
|
1122
|
+
| `tigris objects set-access` (sa) | Set the access level (public or private) on an existing object |
|
|
1123
|
+
| `tigris objects info` (i) | Show metadata for an object (content type, size, modified date) |
|
|
1124
|
+
| `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 |
|
|
1125
|
+
| `tigris objects restore-info` (ri) | Show the restore state of an archived object (archived, in-progress, or restored) |
|
|
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) | 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
1128
|
|
|
1129
1129
|
#### `tigris objects list` (l)
|
|
1130
1130
|
|
|
@@ -1134,15 +1134,15 @@ List objects in a bucket, optionally filtered by a key prefix
|
|
|
1134
1134
|
tigris objects list <bucket> [flags]
|
|
1135
1135
|
```
|
|
1136
1136
|
|
|
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`
|
|
1137
|
+
| Flag | Description |
|
|
1138
|
+
| ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1139
|
+
| `-p, --prefix` | Filter objects by key prefix (e.g. "images/" to list only images) |
|
|
1140
|
+
| `--format` | Output format (default: table) |
|
|
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` | Maximum number of items to return per page |
|
|
1143
|
+
| `-pt, --page-token` | Pagination token from a previous request to fetch the next page |
|
|
1144
|
+
| `--source` | List objects from a specific storage source on buckets with shadow migration enabled |
|
|
1145
|
+
| `--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
1146
|
|
|
1147
1147
|
**Examples:**
|
|
1148
1148
|
```bash
|
|
@@ -1162,15 +1162,15 @@ List object versions and delete markers in a bucket (requires bucket versioning)
|
|
|
1162
1162
|
tigris objects list-versions <bucket> [flags]
|
|
1163
1163
|
```
|
|
1164
1164
|
|
|
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`
|
|
1165
|
+
| Flag | Description |
|
|
1166
|
+
| --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1167
|
+
| `-p, --prefix` | Filter by key prefix |
|
|
1168
|
+
| `-d, --delimiter` | Group keys sharing a common prefix up to the delimiter (e.g. "/" for folder-style grouping) |
|
|
1169
|
+
| `--format` | Output format (default: table) |
|
|
1170
|
+
| `--limit` | Maximum number of items to return per page |
|
|
1171
|
+
| `--key-marker` | Pagination marker — the key to start listing from (from a prior nextKeyMarker) |
|
|
1172
|
+
| `--version-id-marker` | Pagination marker — the version id to start listing from (from a prior nextVersionIdMarker) |
|
|
1173
|
+
| `--deleted` | List the recoverable versions of soft-deleted objects. Use the version id with "tigris objects restore-deleted" or "tigris objects purge" |
|
|
1174
1174
|
|
|
1175
1175
|
**Examples:**
|
|
1176
1176
|
```bash
|
|
@@ -1189,12 +1189,12 @@ Download an object by key. Prints to stdout by default, or saves to a file with
|
|
|
1189
1189
|
tigris objects get <bucket> [key] [flags]
|
|
1190
1190
|
```
|
|
1191
1191
|
|
|
1192
|
-
| Flag
|
|
1193
|
-
|
|
1194
|
-
| `-o, --output`
|
|
1195
|
-
| `-m, --mode`
|
|
1192
|
+
| Flag | Description |
|
|
1193
|
+
| ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1194
|
+
| `-o, --output` | Output file path (if not specified, prints to stdout) |
|
|
1195
|
+
| `-m, --mode` | Response mode: "string" loads into memory, "stream" writes in chunks (auto-detected from extension if not specified) |
|
|
1196
1196
|
| `-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`
|
|
1197
|
+
| `--version-id` | Object version id to download (requires bucket versioning). Omit to download the latest version |
|
|
1198
1198
|
|
|
1199
1199
|
**Examples:**
|
|
1200
1200
|
```bash
|
|
@@ -1211,12 +1211,12 @@ Upload a local file — or data piped via stdin — as an object. Content-type i
|
|
|
1211
1211
|
tigris objects put <bucket> [key] [file] [flags]
|
|
1212
1212
|
```
|
|
1213
1213
|
|
|
1214
|
-
| Flag
|
|
1215
|
-
|
|
1216
|
-
| `-a, --access`
|
|
1217
|
-
| `-t, --content-type` | Content type (auto-detected from extension if omitted)
|
|
1218
|
-
| `--cache-control`
|
|
1219
|
-
| `--format`
|
|
1214
|
+
| Flag | Description |
|
|
1215
|
+
| -------------------- | ------------------------------------------------------------------------------------------------------------------- |
|
|
1216
|
+
| `-a, --access` | Access level (default: private) |
|
|
1217
|
+
| `-t, --content-type` | Content type (auto-detected from extension if omitted) |
|
|
1218
|
+
| `--cache-control` | Cache-Control header stored with the object and returned on every read (e.g. "public, max-age=31536000, immutable") |
|
|
1219
|
+
| `--format` | Output format (default: table) |
|
|
1220
1220
|
|
|
1221
1221
|
**Examples:**
|
|
1222
1222
|
```bash
|
|
@@ -1236,12 +1236,12 @@ Delete one or more objects by key from the given bucket. On a versioned bucket,
|
|
|
1236
1236
|
tigris objects delete <bucket> [key] [flags]
|
|
1237
1237
|
```
|
|
1238
1238
|
|
|
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`
|
|
1239
|
+
| Flag | Description |
|
|
1240
|
+
| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1241
|
+
| `-y, --yes` | Skip confirmation prompts |
|
|
1242
|
+
| `--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" |
|
|
1243
|
+
| `--all-versions` | Hard-delete every version and delete marker for the given key(s). Mutually exclusive with --version-id |
|
|
1244
|
+
| `--force` | Skip confirmation prompts (alias for --yes) |
|
|
1245
1245
|
|
|
1246
1246
|
**Examples:**
|
|
1247
1247
|
```bash
|
|
@@ -1260,9 +1260,9 @@ tigris objects delete my-bucket old-file.txt --all-versions --yes
|
|
|
1260
1260
|
tigris objects set <bucket> [key] [flags]
|
|
1261
1261
|
```
|
|
1262
1262
|
|
|
1263
|
-
| Flag
|
|
1264
|
-
|
|
1265
|
-
| `-a, --access`
|
|
1263
|
+
| Flag | Description |
|
|
1264
|
+
| --------------- | ------------------------------ |
|
|
1265
|
+
| `-a, --access` | Access level **(required)** |
|
|
1266
1266
|
| `-n, --new-key` | Rename the object to a new key |
|
|
1267
1267
|
|
|
1268
1268
|
**Examples:**
|
|
@@ -1280,8 +1280,8 @@ Set the access level (public or private) on an existing object
|
|
|
1280
1280
|
tigris objects set-access <bucket> [key] [access] [flags]
|
|
1281
1281
|
```
|
|
1282
1282
|
|
|
1283
|
-
| Flag
|
|
1284
|
-
|
|
1283
|
+
| Flag | Description |
|
|
1284
|
+
| ---------- | ------------------------------ |
|
|
1285
1285
|
| `--format` | Output format (default: table) |
|
|
1286
1286
|
|
|
1287
1287
|
**Examples:**
|
|
@@ -1298,11 +1298,11 @@ Show metadata for an object (content type, size, modified date)
|
|
|
1298
1298
|
tigris objects info <bucket> [key] [flags]
|
|
1299
1299
|
```
|
|
1300
1300
|
|
|
1301
|
-
| Flag
|
|
1302
|
-
|
|
1303
|
-
| `--format`
|
|
1304
|
-
| `-snapshot, --snapshot-version` | Read from a specific bucket snapshot
|
|
1305
|
-
| `--version-id`
|
|
1301
|
+
| Flag | Description |
|
|
1302
|
+
| ------------------------------- | ------------------------------------------------------------------------------- |
|
|
1303
|
+
| `--format` | Output format (default: table) |
|
|
1304
|
+
| `-snapshot, --snapshot-version` | Read from a specific bucket snapshot |
|
|
1305
|
+
| `--version-id` | Object version id (requires bucket versioning). Omit to read the latest version |
|
|
1306
1306
|
|
|
1307
1307
|
**Examples:**
|
|
1308
1308
|
```bash
|
|
@@ -1320,12 +1320,12 @@ Restore an archived object (e.g. one in the GLACIER tier) into an actively-reada
|
|
|
1320
1320
|
tigris objects restore <bucket> [key] [flags]
|
|
1321
1321
|
```
|
|
1322
1322
|
|
|
1323
|
-
| Flag
|
|
1324
|
-
|
|
1325
|
-
| `-d, --days`
|
|
1326
|
-
| `--version-id`
|
|
1323
|
+
| Flag | Description |
|
|
1324
|
+
| ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1325
|
+
| `-d, --days` | How many days the restored copy stays available before reverting to its archived tier (default: 1) |
|
|
1326
|
+
| `--version-id` | Restore a specific object version (requires bucket versioning). Omit to restore the current version |
|
|
1327
1327
|
| `-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`
|
|
1328
|
+
| `--format` | Output format (default: table) |
|
|
1329
1329
|
|
|
1330
1330
|
**Examples:**
|
|
1331
1331
|
```bash
|
|
@@ -1343,11 +1343,11 @@ Show the restore state of an archived object (archived, in-progress, or restored
|
|
|
1343
1343
|
tigris objects restore-info <bucket> [key] [flags]
|
|
1344
1344
|
```
|
|
1345
1345
|
|
|
1346
|
-
| Flag
|
|
1347
|
-
|
|
1348
|
-
| `--version-id`
|
|
1346
|
+
| Flag | Description |
|
|
1347
|
+
| ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1348
|
+
| `--version-id` | Inspect a specific object version (requires bucket versioning). Omit to read the current version |
|
|
1349
1349
|
| `-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`
|
|
1350
|
+
| `--format` | Output format (default: table) |
|
|
1351
1351
|
|
|
1352
1352
|
**Examples:**
|
|
1353
1353
|
```bash
|
|
@@ -1364,10 +1364,10 @@ Restore a soft-deleted object within its retention window. List recoverable obje
|
|
|
1364
1364
|
tigris objects restore-deleted <bucket> [key] [flags]
|
|
1365
1365
|
```
|
|
1366
1366
|
|
|
1367
|
-
| Flag
|
|
1368
|
-
|
|
1367
|
+
| Flag | Description |
|
|
1368
|
+
| -------------- | ---------------------------------------------------------------------------------------------------- |
|
|
1369
1369
|
| `--version-id` | The soft-deleted version to bring back, from "tigris objects list-versions --deleted" **(required)** |
|
|
1370
|
-
| `--format`
|
|
1370
|
+
| `--format` | Output format (default: table) |
|
|
1371
1371
|
|
|
1372
1372
|
**Examples:**
|
|
1373
1373
|
```bash
|
|
@@ -1383,12 +1383,12 @@ Permanently destroy a soft-deleted object version before its retention period ex
|
|
|
1383
1383
|
tigris objects purge <bucket> [key] [flags]
|
|
1384
1384
|
```
|
|
1385
1385
|
|
|
1386
|
-
| Flag
|
|
1387
|
-
|
|
1388
|
-
| `-y, --yes`
|
|
1386
|
+
| Flag | Description |
|
|
1387
|
+
| -------------- | ------------------------------------------------------------------------------------------------- |
|
|
1388
|
+
| `-y, --yes` | Skip confirmation prompts |
|
|
1389
1389
|
| `--version-id` | The soft-deleted version to destroy, from "tigris objects list-versions --deleted" **(required)** |
|
|
1390
|
-
| `--force`
|
|
1391
|
-
| `--format`
|
|
1390
|
+
| `--force` | Skip confirmation prompts (alias for --yes) |
|
|
1391
|
+
| `--format` | Output format (default: table) |
|
|
1392
1392
|
|
|
1393
1393
|
**Examples:**
|
|
1394
1394
|
```bash
|
|
@@ -1400,18 +1400,18 @@ tigris objects purge t3://my-bucket/report.pdf --version-id 1787749774802410496
|
|
|
1400
1400
|
|
|
1401
1401
|
Create, list, inspect, delete, and assign roles to access keys. Access keys are credentials used for programmatic API access
|
|
1402
1402
|
|
|
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
|
|
1403
|
+
| Command | Description |
|
|
1404
|
+
| --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1405
|
+
| `tigris access-keys list` (l) | List all access keys in the current organization |
|
|
1406
|
+
| `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) |
|
|
1407
|
+
| `tigris access-keys delete` (d) | Permanently delete one or more access keys by ID. This revokes all access immediately |
|
|
1408
|
+
| `tigris access-keys get` (g) | Show details for an access key including its name, creation date, default permissions, and assigned bucket roles |
|
|
1409
|
+
| `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 |
|
|
1410
|
+
| `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 |
|
|
1411
|
+
| `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) |
|
|
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 |
|
|
1415
1415
|
|
|
1416
1416
|
#### `tigris access-keys list` (l)
|
|
1417
1417
|
|
|
@@ -1421,10 +1421,10 @@ List all access keys in the current organization
|
|
|
1421
1421
|
tigris access-keys list [flags]
|
|
1422
1422
|
```
|
|
1423
1423
|
|
|
1424
|
-
| Flag
|
|
1425
|
-
|
|
1426
|
-
| `--format`
|
|
1427
|
-
| `--limit`
|
|
1424
|
+
| Flag | Description |
|
|
1425
|
+
| ------------------- | --------------------------------------------------------------- |
|
|
1426
|
+
| `--format` | Output format (default: table) |
|
|
1427
|
+
| `--limit` | Maximum number of items to return per page |
|
|
1428
1428
|
| `-pt, --page-token` | Pagination token from a previous request to fetch the next page |
|
|
1429
1429
|
|
|
1430
1430
|
**Examples:**
|
|
@@ -1440,15 +1440,15 @@ Create a new access key, optionally scoped to buckets, and export its credential
|
|
|
1440
1440
|
tigris access-keys create <name> [flags]
|
|
1441
1441
|
```
|
|
1442
1442
|
|
|
1443
|
-
| Flag
|
|
1444
|
-
|
|
1445
|
-
| `-b, --bucket`
|
|
1446
|
-
| `-r, --role`
|
|
1447
|
-
| `--admin`
|
|
1443
|
+
| Flag | Description |
|
|
1444
|
+
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1445
|
+
| `-b, --bucket` | Bucket name (can specify multiple, comma-separated). Each bucket is paired positionally with a --role value |
|
|
1446
|
+
| `-r, --role` | Role to assign (can specify multiple, comma-separated). Each role pairs with the corresponding --bucket value |
|
|
1447
|
+
| `--admin` | Grant admin access to all buckets in the organization |
|
|
1448
1448
|
| `--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`
|
|
1449
|
+
| `--env` | Write the credentials to a dotenv file, merging into it when it already exists. Defaults to ./.env. The secret is then not printed |
|
|
1450
|
+
| `--export` | Print the credentials as shell "export" lines and nothing else on stdout, for eval "$(tigris access-keys create <name> --export)" |
|
|
1451
|
+
| `--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
1452
|
|
|
1453
1453
|
**Examples:**
|
|
1454
1454
|
```bash
|
|
@@ -1466,10 +1466,10 @@ Permanently delete one or more access keys by ID. This revokes all access immedi
|
|
|
1466
1466
|
tigris access-keys delete <id> [flags]
|
|
1467
1467
|
```
|
|
1468
1468
|
|
|
1469
|
-
| Flag
|
|
1470
|
-
|
|
1471
|
-
| `-y, --yes` | Skip confirmation prompts
|
|
1472
|
-
| `--force`
|
|
1469
|
+
| Flag | Description |
|
|
1470
|
+
| ----------- | ------------------------------------------- |
|
|
1471
|
+
| `-y, --yes` | Skip confirmation prompts |
|
|
1472
|
+
| `--force` | Skip confirmation prompts (alias for --yes) |
|
|
1473
1473
|
|
|
1474
1474
|
**Examples:**
|
|
1475
1475
|
```bash
|
|
@@ -1498,12 +1498,12 @@ Assign per-bucket roles to an access key. Pair each --bucket with a --role (Edit
|
|
|
1498
1498
|
tigris access-keys assign <id> [flags]
|
|
1499
1499
|
```
|
|
1500
1500
|
|
|
1501
|
-
| Flag
|
|
1502
|
-
|
|
1503
|
-
| `-b, --bucket`
|
|
1504
|
-
| `-r, --role`
|
|
1505
|
-
| `--admin`
|
|
1506
|
-
| `--revoke-roles` | Revoke all bucket roles from the access key
|
|
1501
|
+
| Flag | Description |
|
|
1502
|
+
| ---------------- | ------------------------------------------------------------------------------------------------------------- |
|
|
1503
|
+
| `-b, --bucket` | Bucket name (can specify multiple, comma-separated). Each bucket is paired positionally with a --role value |
|
|
1504
|
+
| `-r, --role` | Role to assign (can specify multiple, comma-separated). Each role pairs with the corresponding --bucket value |
|
|
1505
|
+
| `--admin` | Grant admin access to all buckets in the organization |
|
|
1506
|
+
| `--revoke-roles` | Revoke all bucket roles from the access key |
|
|
1507
1507
|
|
|
1508
1508
|
**Examples:**
|
|
1509
1509
|
```bash
|
|
@@ -1521,8 +1521,8 @@ Update settings on an existing access key — currently its default permissions,
|
|
|
1521
1521
|
tigris access-keys set <id> [flags]
|
|
1522
1522
|
```
|
|
1523
1523
|
|
|
1524
|
-
| Flag
|
|
1525
|
-
|
|
1524
|
+
| Flag | Description |
|
|
1525
|
+
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1526
1526
|
| `--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
1527
|
|
|
1528
1528
|
**Examples:**
|
|
@@ -1539,10 +1539,10 @@ Rotate an access key's secret. The current secret is immediately invalidated and
|
|
|
1539
1539
|
tigris access-keys rotate <id> [flags]
|
|
1540
1540
|
```
|
|
1541
1541
|
|
|
1542
|
-
| Flag
|
|
1543
|
-
|
|
1544
|
-
| `-y, --yes` | Skip confirmation prompts
|
|
1545
|
-
| `--force`
|
|
1542
|
+
| Flag | Description |
|
|
1543
|
+
| ----------- | ------------------------------------------- |
|
|
1544
|
+
| `-y, --yes` | Skip confirmation prompts |
|
|
1545
|
+
| `--force` | Skip confirmation prompts (alias for --yes) |
|
|
1546
1546
|
|
|
1547
1547
|
**Examples:**
|
|
1548
1548
|
```bash
|
|
@@ -1557,8 +1557,8 @@ Attach an IAM policy to an access key. If no policy ARN is provided, shows inter
|
|
|
1557
1557
|
tigris access-keys attach-policy <id> [flags]
|
|
1558
1558
|
```
|
|
1559
1559
|
|
|
1560
|
-
| Flag
|
|
1561
|
-
|
|
1560
|
+
| Flag | Description |
|
|
1561
|
+
| -------------- | --------------------------- |
|
|
1562
1562
|
| `--policy-arn` | ARN of the policy to attach |
|
|
1563
1563
|
|
|
1564
1564
|
**Examples:**
|
|
@@ -1575,11 +1575,11 @@ Detach an IAM policy from an access key. If no policy ARN is provided, shows int
|
|
|
1575
1575
|
tigris access-keys detach-policy <id> [flags]
|
|
1576
1576
|
```
|
|
1577
1577
|
|
|
1578
|
-
| Flag
|
|
1579
|
-
|
|
1580
|
-
| `-y, --yes`
|
|
1581
|
-
| `--policy-arn` | ARN of the policy to detach
|
|
1582
|
-
| `--force`
|
|
1578
|
+
| Flag | Description |
|
|
1579
|
+
| -------------- | ------------------------------------------- |
|
|
1580
|
+
| `-y, --yes` | Skip confirmation prompts |
|
|
1581
|
+
| `--policy-arn` | ARN of the policy to detach |
|
|
1582
|
+
| `--force` | Skip confirmation prompts (alias for --yes) |
|
|
1583
1583
|
|
|
1584
1584
|
**Examples:**
|
|
1585
1585
|
```bash
|
|
@@ -1595,10 +1595,10 @@ List all IAM policies attached to an access key
|
|
|
1595
1595
|
tigris access-keys list-policies <id> [flags]
|
|
1596
1596
|
```
|
|
1597
1597
|
|
|
1598
|
-
| Flag
|
|
1599
|
-
|
|
1600
|
-
| `--format`
|
|
1601
|
-
| `--limit`
|
|
1598
|
+
| Flag | Description |
|
|
1599
|
+
| ------------------- | --------------------------------------------------------------- |
|
|
1600
|
+
| `--format` | Output format (default: table) |
|
|
1601
|
+
| `--limit` | Maximum number of items to return per page |
|
|
1602
1602
|
| `-pt, --page-token` | Pagination token from a previous request to fetch the next page |
|
|
1603
1603
|
|
|
1604
1604
|
**Examples:**
|
|
@@ -1610,26 +1610,26 @@ tigris access-keys list-policies tid_AaBbCcDdEeFf
|
|
|
1610
1610
|
|
|
1611
1611
|
Identity and Access Management - manage policies, users, and permissions
|
|
1612
1612
|
|
|
1613
|
-
| Command
|
|
1614
|
-
|
|
1613
|
+
| Command | Description |
|
|
1614
|
+
| ------------------------- | ---------------------------------------------------------------- |
|
|
1615
1615
|
| `tigris iam policies` (p) | Manage IAM policies. Policies define permissions for access keys |
|
|
1616
|
-
| `tigris iam users` (u)
|
|
1617
|
-
| `tigris iam teams` (t)
|
|
1616
|
+
| `tigris iam users` (u) | Manage organization users and invitations |
|
|
1617
|
+
| `tigris iam teams` (t) | Manage organization teams |
|
|
1618
1618
|
|
|
1619
1619
|
#### `tigris iam policies` (p)
|
|
1620
1620
|
|
|
1621
1621
|
Manage IAM policies. Policies define permissions for access keys
|
|
1622
1622
|
|
|
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)
|
|
1623
|
+
| Command | Description |
|
|
1624
|
+
| --------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1625
|
+
| `tigris iam policies list` (l) | List all policies in the current organization |
|
|
1626
|
+
| `tigris iam policies get` (g) | Show details for a policy including its document and attached users. If no ARN provided, shows interactive selection |
|
|
1627
|
+
| `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 |
|
|
1628
|
+
| `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 |
|
|
1629
|
+
| `tigris iam policies delete` (d) | Delete a policy. If no ARN provided, shows interactive selection |
|
|
1630
|
+
| `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
1631
|
| `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)
|
|
1632
|
+
| `tigris iam policies list-keys` (lk) | List all access keys attached to a policy. If no policy ARN is provided, shows interactive selection |
|
|
1633
1633
|
|
|
1634
1634
|
##### `tigris iam policies list` (l)
|
|
1635
1635
|
|
|
@@ -1639,10 +1639,10 @@ List all policies in the current organization
|
|
|
1639
1639
|
tigris iam policies list [flags]
|
|
1640
1640
|
```
|
|
1641
1641
|
|
|
1642
|
-
| Flag
|
|
1643
|
-
|
|
1644
|
-
| `--format`
|
|
1645
|
-
| `--limit`
|
|
1642
|
+
| Flag | Description |
|
|
1643
|
+
| ------------------- | --------------------------------------------------------------- |
|
|
1644
|
+
| `--format` | Output format (default: table) |
|
|
1645
|
+
| `--limit` | Maximum number of items to return per page |
|
|
1646
1646
|
| `-pt, --page-token` | Pagination token from a previous request to fetch the next page |
|
|
1647
1647
|
|
|
1648
1648
|
**Examples:**
|
|
@@ -1658,8 +1658,8 @@ Show details for a policy including its document and attached users. If no ARN p
|
|
|
1658
1658
|
tigris iam policies get [resource] [flags]
|
|
1659
1659
|
```
|
|
1660
1660
|
|
|
1661
|
-
| Flag
|
|
1662
|
-
|
|
1661
|
+
| Flag | Description |
|
|
1662
|
+
| ---------- | ------------------------------ |
|
|
1663
1663
|
| `--format` | Output format (default: table) |
|
|
1664
1664
|
|
|
1665
1665
|
**Examples:**
|
|
@@ -1676,10 +1676,10 @@ Create a new policy with the given name and policy document. Document can be pro
|
|
|
1676
1676
|
tigris iam policies create <name> [flags]
|
|
1677
1677
|
```
|
|
1678
1678
|
|
|
1679
|
-
| Flag
|
|
1680
|
-
|
|
1679
|
+
| Flag | Description |
|
|
1680
|
+
| ---------------- | ----------------------------------------------------------------------------- |
|
|
1681
1681
|
| `-d, --document` | Policy document (JSON file path or inline JSON). If omitted, reads from stdin |
|
|
1682
|
-
| `--description`
|
|
1682
|
+
| `--description` | Policy description |
|
|
1683
1683
|
|
|
1684
1684
|
**Examples:**
|
|
1685
1685
|
```bash
|
|
@@ -1696,10 +1696,10 @@ Update an existing policy's document. Document can be provided via file, inline
|
|
|
1696
1696
|
tigris iam policies edit [resource] [flags]
|
|
1697
1697
|
```
|
|
1698
1698
|
|
|
1699
|
-
| Flag
|
|
1700
|
-
|
|
1699
|
+
| Flag | Description |
|
|
1700
|
+
| ---------------- | --------------------------------------------------------------------------------- |
|
|
1701
1701
|
| `-d, --document` | New policy document (JSON file path or inline JSON). If omitted, reads from stdin |
|
|
1702
|
-
| `--description`
|
|
1702
|
+
| `--description` | Update policy description |
|
|
1703
1703
|
|
|
1704
1704
|
**Examples:**
|
|
1705
1705
|
```bash
|
|
@@ -1716,10 +1716,10 @@ Delete a policy. If no ARN provided, shows interactive selection
|
|
|
1716
1716
|
tigris iam policies delete [resource] [flags]
|
|
1717
1717
|
```
|
|
1718
1718
|
|
|
1719
|
-
| Flag
|
|
1720
|
-
|
|
1721
|
-
| `-y, --yes` | Skip confirmation prompts
|
|
1722
|
-
| `--force`
|
|
1719
|
+
| Flag | Description |
|
|
1720
|
+
| ----------- | ------------------------------------------- |
|
|
1721
|
+
| `-y, --yes` | Skip confirmation prompts |
|
|
1722
|
+
| `--force` | Skip confirmation prompts (alias for --yes) |
|
|
1723
1723
|
|
|
1724
1724
|
**Examples:**
|
|
1725
1725
|
```bash
|
|
@@ -1735,8 +1735,8 @@ Link an access key to a policy. If no policy ARN is provided, shows interactive
|
|
|
1735
1735
|
tigris iam policies link-key [resource] [flags]
|
|
1736
1736
|
```
|
|
1737
1737
|
|
|
1738
|
-
| Flag
|
|
1739
|
-
|
|
1738
|
+
| Flag | Description |
|
|
1739
|
+
| ------ | ----------------------- |
|
|
1740
1740
|
| `--id` | Access key ID to attach |
|
|
1741
1741
|
|
|
1742
1742
|
**Examples:**
|
|
@@ -1753,11 +1753,11 @@ Unlink an access key from a policy. If no policy ARN is provided, shows interact
|
|
|
1753
1753
|
tigris iam policies unlink-key [resource] [flags]
|
|
1754
1754
|
```
|
|
1755
1755
|
|
|
1756
|
-
| Flag
|
|
1757
|
-
|
|
1758
|
-
| `-y, --yes` | Skip confirmation prompts
|
|
1759
|
-
| `--id`
|
|
1760
|
-
| `--force`
|
|
1756
|
+
| Flag | Description |
|
|
1757
|
+
| ----------- | ------------------------------------------- |
|
|
1758
|
+
| `-y, --yes` | Skip confirmation prompts |
|
|
1759
|
+
| `--id` | Access key ID to detach |
|
|
1760
|
+
| `--force` | Skip confirmation prompts (alias for --yes) |
|
|
1761
1761
|
|
|
1762
1762
|
**Examples:**
|
|
1763
1763
|
```bash
|
|
@@ -1773,8 +1773,8 @@ List all access keys attached to a policy. If no policy ARN is provided, shows i
|
|
|
1773
1773
|
tigris iam policies list-keys [resource] [flags]
|
|
1774
1774
|
```
|
|
1775
1775
|
|
|
1776
|
-
| Flag
|
|
1777
|
-
|
|
1776
|
+
| Flag | Description |
|
|
1777
|
+
| ---------- | ------------------------------ |
|
|
1778
1778
|
| `--format` | Output format (default: table) |
|
|
1779
1779
|
|
|
1780
1780
|
**Examples:**
|
|
@@ -1787,13 +1787,13 @@ tigris iam policies list-keys
|
|
|
1787
1787
|
|
|
1788
1788
|
Manage organization users and invitations
|
|
1789
1789
|
|
|
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)
|
|
1790
|
+
| Command | Description |
|
|
1791
|
+
| ----------------------------------------- | ------------------------------------------------------------------------------------------ |
|
|
1792
|
+
| `tigris iam users list` (l) | List all users and pending invitations in the organization |
|
|
1793
|
+
| `tigris iam users invite` (i) | Invite users to the organization by email |
|
|
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) | Update user roles in the organization. If no user ID provided, shows interactive selection |
|
|
1796
|
+
| `tigris iam users remove` (rm) | Remove users from the organization. If no user ID provided, shows interactive selection |
|
|
1797
1797
|
|
|
1798
1798
|
##### `tigris iam users list` (l)
|
|
1799
1799
|
|
|
@@ -1803,8 +1803,8 @@ List all users and pending invitations in the organization
|
|
|
1803
1803
|
tigris iam users list [flags]
|
|
1804
1804
|
```
|
|
1805
1805
|
|
|
1806
|
-
| Flag
|
|
1807
|
-
|
|
1806
|
+
| Flag | Description |
|
|
1807
|
+
| ---------- | ------------------------------ |
|
|
1808
1808
|
| `--format` | Output format (default: table) |
|
|
1809
1809
|
|
|
1810
1810
|
**Examples:**
|
|
@@ -1821,8 +1821,8 @@ Invite users to the organization by email
|
|
|
1821
1821
|
tigris iam users invite <email> [flags]
|
|
1822
1822
|
```
|
|
1823
1823
|
|
|
1824
|
-
| Flag
|
|
1825
|
-
|
|
1824
|
+
| Flag | Description |
|
|
1825
|
+
| ------------ | ------------------------------------------------------- |
|
|
1826
1826
|
| `-r, --role` | Role to assign to the invited user(s) (default: member) |
|
|
1827
1827
|
|
|
1828
1828
|
**Examples:**
|
|
@@ -1840,10 +1840,10 @@ Revoke pending invitations. If no invitation ID provided, shows interactive sele
|
|
|
1840
1840
|
tigris iam users revoke-invitation [resource] [flags]
|
|
1841
1841
|
```
|
|
1842
1842
|
|
|
1843
|
-
| Flag
|
|
1844
|
-
|
|
1845
|
-
| `-y, --yes` | Skip confirmation prompts
|
|
1846
|
-
| `--force`
|
|
1843
|
+
| Flag | Description |
|
|
1844
|
+
| ----------- | ------------------------------------------- |
|
|
1845
|
+
| `-y, --yes` | Skip confirmation prompts |
|
|
1846
|
+
| `--force` | Skip confirmation prompts (alias for --yes) |
|
|
1847
1847
|
|
|
1848
1848
|
**Examples:**
|
|
1849
1849
|
```bash
|
|
@@ -1860,8 +1860,8 @@ Update user roles in the organization. If no user ID provided, shows interactive
|
|
|
1860
1860
|
tigris iam users update-role [resource] [flags]
|
|
1861
1861
|
```
|
|
1862
1862
|
|
|
1863
|
-
| Flag
|
|
1864
|
-
|
|
1863
|
+
| Flag | Description |
|
|
1864
|
+
| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1865
1865
|
| `-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
1866
|
|
|
1867
1867
|
**Examples:**
|
|
@@ -1880,10 +1880,10 @@ Remove users from the organization. If no user ID provided, shows interactive se
|
|
|
1880
1880
|
tigris iam users remove [resource] [flags]
|
|
1881
1881
|
```
|
|
1882
1882
|
|
|
1883
|
-
| Flag
|
|
1884
|
-
|
|
1885
|
-
| `-y, --yes` | Skip confirmation prompts
|
|
1886
|
-
| `--force`
|
|
1883
|
+
| Flag | Description |
|
|
1884
|
+
| ----------- | ------------------------------------------- |
|
|
1885
|
+
| `-y, --yes` | Skip confirmation prompts |
|
|
1886
|
+
| `--force` | Skip confirmation prompts (alias for --yes) |
|
|
1887
1887
|
|
|
1888
1888
|
**Examples:**
|
|
1889
1889
|
```bash
|
|
@@ -1896,11 +1896,11 @@ tigris iam users remove user@example.com,user@example.net --yes
|
|
|
1896
1896
|
|
|
1897
1897
|
Manage organization teams
|
|
1898
1898
|
|
|
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)
|
|
1899
|
+
| Command | Description |
|
|
1900
|
+
| ----------------------------- | ------------------------------------------------------------------------------------------ |
|
|
1901
|
+
| `tigris iam teams list` (l) | List all teams in the organization |
|
|
1902
|
+
| `tigris iam teams create` (c) | Create a new team in the organization |
|
|
1903
|
+
| `tigris iam teams edit` (e) | Update a team's name, description, or members. Members are replaced with the provided list |
|
|
1904
1904
|
|
|
1905
1905
|
##### `tigris iam teams list` (l)
|
|
1906
1906
|
|
|
@@ -1910,8 +1910,8 @@ List all teams in the organization
|
|
|
1910
1910
|
tigris iam teams list [flags]
|
|
1911
1911
|
```
|
|
1912
1912
|
|
|
1913
|
-
| Flag
|
|
1914
|
-
|
|
1913
|
+
| Flag | Description |
|
|
1914
|
+
| ---------- | ------------------------------ |
|
|
1915
1915
|
| `--format` | Output format (default: table) |
|
|
1916
1916
|
|
|
1917
1917
|
**Examples:**
|
|
@@ -1928,10 +1928,10 @@ Create a new team in the organization
|
|
|
1928
1928
|
tigris iam teams create <name> [flags]
|
|
1929
1929
|
```
|
|
1930
1930
|
|
|
1931
|
-
| Flag
|
|
1932
|
-
|
|
1933
|
-
| `-d, --description` | Description for the team
|
|
1934
|
-
| `-m, --members`
|
|
1931
|
+
| Flag | Description |
|
|
1932
|
+
| ------------------- | -------------------------------------------------------------- |
|
|
1933
|
+
| `-d, --description` | Description for the team |
|
|
1934
|
+
| `-m, --members` | Member email address(es) to add (comma-separated for multiple) |
|
|
1935
1935
|
|
|
1936
1936
|
**Examples:**
|
|
1937
1937
|
```bash
|
|
@@ -1948,11 +1948,11 @@ Update a team's name, description, or members. Members are replaced with the pro
|
|
|
1948
1948
|
tigris iam teams edit <id> [flags]
|
|
1949
1949
|
```
|
|
1950
1950
|
|
|
1951
|
-
| Flag
|
|
1952
|
-
|
|
1953
|
-
| `-n, --name`
|
|
1954
|
-
| `-d, --description` | New description for the team
|
|
1955
|
-
| `-m, --members`
|
|
1951
|
+
| Flag | Description |
|
|
1952
|
+
| ------------------- | -------------------------------------------------------------------------------------- |
|
|
1953
|
+
| `-n, --name` | New name for the team |
|
|
1954
|
+
| `-d, --description` | New description for the team |
|
|
1955
|
+
| `-m, --members` | Replace the team's members with these email address(es) (comma-separated for multiple) |
|
|
1956
1956
|
|
|
1957
1957
|
**Examples:**
|
|
1958
1958
|
```bash
|
|
@@ -1975,6 +1975,26 @@ tigris telemetry enable
|
|
|
1975
1975
|
`TIGRIS_NO_TELEMETRY=1` or `DO_NOT_TRACK=1` also disable it and take precedence
|
|
1976
1976
|
over the stored setting. Telemetry is off in development builds and test runs.
|
|
1977
1977
|
|
|
1978
|
+
Usage analytics send one `cli_command` event per command, when it finishes.
|
|
1979
|
+
Besides the command, its scrubbed arguments, flag names, CLI and OS versions,
|
|
1980
|
+
install method and auth method, each event records the outcome:
|
|
1981
|
+
|
|
1982
|
+
| Property | Meaning |
|
|
1983
|
+
| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1984
|
+
| `success` | `true` when the command exited 0 |
|
|
1985
|
+
| `exit_code` | The process exit code (`130` for Ctrl-C) |
|
|
1986
|
+
| `duration_ms` | Time from dispatch to exit |
|
|
1987
|
+
| `error_category` | On failure: `auth`, `permission`, `not_found`, `rate_limit`, `network`, `general`, `usage` (rejected before any work, e.g. an unknown flag) or `interrupted` |
|
|
1988
|
+
| `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 |
|
|
1989
|
+
|
|
1990
|
+
The first event or login from a machine also records, once per person,
|
|
1991
|
+
`first_interface: cli`, `first_cli_install_method` and `first_cli_version`.
|
|
1992
|
+
|
|
1993
|
+
Commands never wait on telemetry: events and error reports are written to a
|
|
1994
|
+
private temp file and sent by a short-lived background copy of the CLI after
|
|
1995
|
+
the command exits (`tigris __telemetry-send` is that internal step, not a
|
|
1996
|
+
command to run yourself).
|
|
1997
|
+
|
|
1978
1998
|
## License
|
|
1979
1999
|
|
|
1980
2000
|
MIT
|