@tigrisdata/cli 3.17.0 → 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 +480 -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-RQYVMBA7.js → chunk-4BWK33XD.js} +1 -1
- package/dist/chunk-56W4QIZP.js +4 -0
- package/dist/{chunk-HK3DBOMB.js → chunk-5FFSAQBH.js} +1 -1
- package/dist/chunk-6R467XCM.js +1 -0
- package/dist/{chunk-I234FGXR.js → chunk-A6IZCL2R.js} +1 -1
- package/dist/{chunk-7PRSGIKV.js → chunk-H4VWRKBZ.js} +1 -1
- package/dist/{chunk-CBS7RVDP.js → chunk-JQRHEFN2.js} +1 -1
- package/dist/chunk-L5TE7GWK.js +1 -0
- package/dist/{chunk-4OC6VF2F.js → chunk-QJKKFI5K.js} +1 -1
- package/dist/chunk-QJMLIBCG.js +8 -0
- package/dist/{chunk-VQHXD36W.js → chunk-U63FQLE2.js} +1 -1
- package/dist/chunk-VI5JXLP7.js +1 -0
- package/dist/{chunk-W2SGDHBM.js → chunk-XCHHTO54.js} +1 -1
- package/dist/{chunk-7GBRSLA4.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 +5 -2
- package/dist/chunk-AQZXG57U.js +0 -1
- package/dist/chunk-GE2NFNN4.js +0 -1
- package/dist/chunk-HCEAJ2BC.js +0 -4
- package/dist/chunk-K3ION5DP.js +0 -1
- package/dist/chunk-LBTT65MM.js +0 -3
- package/dist/chunk-UOX26MU3.js +0 -7
- /package/dist/{chunk-JCXPE6O6.js → chunk-2AC5S3JV.js} +0 -0
package/README.md
CHANGED
|
@@ -4,6 +4,8 @@ Command line interface for Tigris object storage.
|
|
|
4
4
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
7
|
+
Requires Node.js 20.19 or later.
|
|
8
|
+
|
|
7
9
|
```bash
|
|
8
10
|
npm install -g @tigrisdata/cli
|
|
9
11
|
```
|
|
@@ -31,32 +33,32 @@ Run `tigris help` to see all available commands, or `tigris <command> help` for
|
|
|
31
33
|
|
|
32
34
|
### Commands
|
|
33
35
|
|
|
34
|
-
| Command
|
|
35
|
-
|
|
36
|
-
| `tigris init` (start)
|
|
37
|
-
| `tigris configure` (c)
|
|
38
|
-
| `tigris login` (l)
|
|
39
|
-
| `tigris whoami` (w)
|
|
40
|
-
| `tigris usage`
|
|
41
|
-
| `tigris update`
|
|
42
|
-
| `tigris logout`
|
|
43
|
-
| `tigris credentials` (creds)
|
|
44
|
-
| `tigris telemetry`
|
|
45
|
-
| `tigris ls` (list)
|
|
46
|
-
| `tigris mk` (create)
|
|
47
|
-
| `tigris touch`
|
|
48
|
-
| `tigris stat`
|
|
49
|
-
| `tigris presign`
|
|
50
|
-
| `tigris cp` (copy)
|
|
51
|
-
| `tigris mv` (move)
|
|
52
|
-
| `tigris rm` (remove)
|
|
53
|
-
| `tigris bundle`
|
|
54
|
-
| `tigris organizations` (orgs) | List, create, and switch between organizations. An organization is a workspace that contains your resources like buckets and access keys
|
|
55
|
-
| `tigris buckets` (b)
|
|
56
|
-
| `tigris snapshots` (s)
|
|
57
|
-
| `tigris objects` (o)
|
|
58
|
-
| `tigris access-keys` (keys)
|
|
59
|
-
| `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 |
|
|
60
62
|
|
|
61
63
|
---
|
|
62
64
|
|
|
@@ -68,8 +70,8 @@ Connect Tigris to your AI coding agent — MCP server config and agent skills
|
|
|
68
70
|
tigris init [flags]
|
|
69
71
|
```
|
|
70
72
|
|
|
71
|
-
| Flag
|
|
72
|
-
|
|
73
|
+
| Flag | Description |
|
|
74
|
+
| --------- | ----------------------------------------------------------------------------------------------- |
|
|
73
75
|
| `--agent` | Print a setup recipe for an AI coding agent to follow instead of running the interactive wizard |
|
|
74
76
|
|
|
75
77
|
**Examples:**
|
|
@@ -87,11 +89,11 @@ Save access-key credentials to ~/.tigris/config.json for persistent use across a
|
|
|
87
89
|
tigris configure [flags]
|
|
88
90
|
```
|
|
89
91
|
|
|
90
|
-
| Flag
|
|
91
|
-
|
|
92
|
-
| `-key, --access-key`
|
|
93
|
-
| `-secret, --access-secret` | Your Tigris secret access key
|
|
94
|
-
| `-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) |
|
|
95
97
|
|
|
96
98
|
**Examples:**
|
|
97
99
|
```bash
|
|
@@ -103,10 +105,10 @@ tigris configure --endpoint https://custom.endpoint.dev
|
|
|
103
105
|
|
|
104
106
|
Start a session via OAuth (default) or temporary credentials. Session state is cleared on logout
|
|
105
107
|
|
|
106
|
-
| Command
|
|
107
|
-
|
|
108
|
-
| `tigris login select`
|
|
109
|
-
| `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 |
|
|
110
112
|
| `tigris login credentials` (c) | Login with an access key and secret. Creates a temporary session that is cleared on logout |
|
|
111
113
|
|
|
112
114
|
#### `tigris login select`
|
|
@@ -138,9 +140,9 @@ Login with an access key and secret. Creates a temporary session that is cleared
|
|
|
138
140
|
tigris login credentials [flags]
|
|
139
141
|
```
|
|
140
142
|
|
|
141
|
-
| Flag
|
|
142
|
-
|
|
143
|
-
| `-key, --access-key`
|
|
143
|
+
| Flag | Description |
|
|
144
|
+
| -------------------------- | ---------------------------------------------------- |
|
|
145
|
+
| `-key, --access-key` | Your access key ID (will prompt if not provided) |
|
|
144
146
|
| `-secret, --access-secret` | Your secret access key (will prompt if not provided) |
|
|
145
147
|
|
|
146
148
|
**Examples:**
|
|
@@ -170,11 +172,11 @@ Show the active organization's usage and charges for a billing month, as on the
|
|
|
170
172
|
tigris usage [flags]
|
|
171
173
|
```
|
|
172
174
|
|
|
173
|
-
| Flag
|
|
174
|
-
|
|
175
|
-
| `--month`
|
|
176
|
-
| `--all`
|
|
177
|
-
| `--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) |
|
|
178
180
|
|
|
179
181
|
**Examples:**
|
|
180
182
|
```bash
|
|
@@ -214,8 +216,8 @@ tigris logout
|
|
|
214
216
|
|
|
215
217
|
Test whether your current credentials can reach Tigris and optionally verify access to a specific bucket
|
|
216
218
|
|
|
217
|
-
| Command
|
|
218
|
-
|
|
219
|
+
| Command | Description |
|
|
220
|
+
| ----------------------------- | ---------------------------------------------------------------------------------------- |
|
|
219
221
|
| `tigris credentials test` (t) | Verify that current credentials are valid. Optionally checks access to a specific bucket |
|
|
220
222
|
|
|
221
223
|
#### `tigris credentials test` (t)
|
|
@@ -226,8 +228,8 @@ Verify that current credentials are valid. Optionally checks access to a specifi
|
|
|
226
228
|
tigris credentials test [flags]
|
|
227
229
|
```
|
|
228
230
|
|
|
229
|
-
| Flag
|
|
230
|
-
|
|
231
|
+
| Flag | Description |
|
|
232
|
+
| -------------- | --------------------------------------------- |
|
|
231
233
|
| `-b, --bucket` | Bucket name to test access against (optional) |
|
|
232
234
|
|
|
233
235
|
**Examples:**
|
|
@@ -240,11 +242,11 @@ tigris credentials test --bucket my-bucket
|
|
|
240
242
|
|
|
241
243
|
Show or change whether the CLI sends usage analytics and error reports
|
|
242
244
|
|
|
243
|
-
| Command
|
|
244
|
-
|
|
245
|
-
| `tigris telemetry status`
|
|
246
|
-
| `tigris telemetry disable` | Turn off usage analytics and error reports on this machine
|
|
247
|
-
| `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 |
|
|
248
250
|
|
|
249
251
|
#### `tigris telemetry status`
|
|
250
252
|
|
|
@@ -293,13 +295,13 @@ List all buckets (no arguments) or objects under a bucket/prefix path. Accepts b
|
|
|
293
295
|
tigris ls [path] [flags]
|
|
294
296
|
```
|
|
295
297
|
|
|
296
|
-
| Flag
|
|
297
|
-
|
|
298
|
+
| Flag | Description |
|
|
299
|
+
| ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
298
300
|
| `-snapshot, --snapshot-version` | Read from a specific bucket snapshot. Accepts a snapshot version string or any UNIX nanosecond-precision timestamp (e.g. 1765889000501544464) |
|
|
299
|
-
| `--format`
|
|
300
|
-
| `--limit`
|
|
301
|
-
| `-pt, --page-token`
|
|
302
|
-
| `--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 |
|
|
303
305
|
|
|
304
306
|
**Examples:**
|
|
305
307
|
```bash
|
|
@@ -317,16 +319,16 @@ Create a bucket (bare name) or a folder inside a bucket (bucket/folder/ with tra
|
|
|
317
319
|
tigris mk <path> [flags]
|
|
318
320
|
```
|
|
319
321
|
|
|
320
|
-
| Flag
|
|
321
|
-
|
|
322
|
-
| `-a, --access`
|
|
323
|
-
| `--public`
|
|
324
|
-
| `-s, --enable-snapshots`
|
|
325
|
-
| `--allow-object-acl`
|
|
326
|
-
| `--enable-directory-listing`
|
|
327
|
-
| `-t, --default-tier`
|
|
328
|
-
| `-l, --locations`
|
|
329
|
-
| `-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 |
|
|
330
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 |
|
|
331
333
|
|
|
332
334
|
**Examples:**
|
|
@@ -363,11 +365,11 @@ Show storage stats (no args), bucket info, or object metadata
|
|
|
363
365
|
tigris stat [path] [flags]
|
|
364
366
|
```
|
|
365
367
|
|
|
366
|
-
| Flag
|
|
367
|
-
|
|
368
|
-
| `--format`
|
|
368
|
+
| Flag | Description |
|
|
369
|
+
| ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
370
|
+
| `--format` | Output format (default: table) |
|
|
369
371
|
| `-snapshot, --snapshot-version` | Read from a specific bucket snapshot. Accepts a snapshot version string or any UNIX nanosecond-precision timestamp (e.g. 1765889000501544464) |
|
|
370
|
-
| `--version-id`
|
|
372
|
+
| `--version-id` | Object version id to stat (requires bucket versioning). Omit to stat the latest version |
|
|
371
373
|
|
|
372
374
|
**Examples:**
|
|
373
375
|
```bash
|
|
@@ -384,13 +386,13 @@ Generate a presigned URL for temporary access to an object without credentials
|
|
|
384
386
|
tigris presign <path> [flags]
|
|
385
387
|
```
|
|
386
388
|
|
|
387
|
-
| Flag
|
|
388
|
-
|
|
389
|
-
| `-m, --method`
|
|
390
|
-
| `-e, --expires-in`
|
|
391
|
-
| `--access-key`
|
|
392
|
-
| `--select`
|
|
393
|
-
| `--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) |
|
|
394
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. |
|
|
395
397
|
|
|
396
398
|
**Examples:**
|
|
@@ -409,10 +411,10 @@ Copy files between local filesystem and Tigris, or between paths within Tigris.
|
|
|
409
411
|
tigris cp <src> <dest> [flags]
|
|
410
412
|
```
|
|
411
413
|
|
|
412
|
-
| Flag
|
|
413
|
-
|
|
414
|
-
| `-r, --recursive` | Copy directories recursively
|
|
415
|
-
| `-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) |
|
|
416
418
|
| `--cache-control` | Cache-Control header stored with uploaded objects (only applies to local-to-remote uploads) |
|
|
417
419
|
|
|
418
420
|
**Examples:**
|
|
@@ -433,11 +435,11 @@ Move (rename) objects within Tigris. Both source and destination must be remote
|
|
|
433
435
|
tigris mv <src> <dest> [flags]
|
|
434
436
|
```
|
|
435
437
|
|
|
436
|
-
| Flag
|
|
437
|
-
|
|
438
|
-
| `-y, --yes`
|
|
439
|
-
| `-r, --recursive` | Move directories recursively
|
|
440
|
-
| `-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) |
|
|
441
443
|
|
|
442
444
|
**Examples:**
|
|
443
445
|
```bash
|
|
@@ -454,11 +456,11 @@ Remove a bucket, folder, or object from Tigris. A bare bucket name deletes the b
|
|
|
454
456
|
tigris rm <path> [flags]
|
|
455
457
|
```
|
|
456
458
|
|
|
457
|
-
| Flag
|
|
458
|
-
|
|
459
|
-
| `-y, --yes`
|
|
460
|
-
| `-r, --recursive` | Remove directories recursively
|
|
461
|
-
| `-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) |
|
|
462
464
|
|
|
463
465
|
**Examples:**
|
|
464
466
|
```bash
|
|
@@ -476,12 +478,12 @@ Download multiple objects as a streaming tar archive in a single request. Design
|
|
|
476
478
|
tigris bundle <bucket> [flags]
|
|
477
479
|
```
|
|
478
480
|
|
|
479
|
-
| Flag
|
|
480
|
-
|
|
481
|
-
| `-k, --keys`
|
|
482
|
-
| `-o, --output`
|
|
483
|
-
| `--compression` | Compression algorithm for the archive. Auto-detected from output file extension when not specified
|
|
484
|
-
| `--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) |
|
|
485
487
|
|
|
486
488
|
**Examples:**
|
|
487
489
|
```bash
|
|
@@ -495,11 +497,11 @@ cat keys.txt | tigris bundle my-bucket > archive.tar
|
|
|
495
497
|
|
|
496
498
|
List, create, and switch between organizations. An organization is a workspace that contains your resources like buckets and access keys
|
|
497
499
|
|
|
498
|
-
| Command
|
|
499
|
-
|
|
500
|
-
| `tigris organizations list` (l)
|
|
501
|
-
| `tigris organizations create` (c) | Create a new organization with the given name
|
|
502
|
-
| `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 |
|
|
503
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 |
|
|
504
506
|
|
|
505
507
|
#### `tigris organizations list` (l)
|
|
@@ -510,10 +512,10 @@ List all organizations you belong to and interactively select one as active
|
|
|
510
512
|
tigris organizations list [flags]
|
|
511
513
|
```
|
|
512
514
|
|
|
513
|
-
| Flag
|
|
514
|
-
|
|
515
|
-
| `--format`
|
|
516
|
-
| `-i, --select` | Interactive selection mode
|
|
515
|
+
| Flag | Description |
|
|
516
|
+
| -------------- | ------------------------------- |
|
|
517
|
+
| `--format` | Output format (default: select) |
|
|
518
|
+
| `-i, --select` | Interactive selection mode |
|
|
517
519
|
|
|
518
520
|
**Examples:**
|
|
519
521
|
```bash
|
|
@@ -555,8 +557,8 @@ Delete an organization you own, picked from a list or given by ID. It must be em
|
|
|
555
557
|
tigris organizations delete [id] [flags]
|
|
556
558
|
```
|
|
557
559
|
|
|
558
|
-
| Flag
|
|
559
|
-
|
|
560
|
+
| Flag | Description |
|
|
561
|
+
| ----------- | ------------------------- |
|
|
560
562
|
| `-y, --yes` | Skip confirmation prompts |
|
|
561
563
|
|
|
562
564
|
**Examples:**
|
|
@@ -569,26 +571,26 @@ tigris orgs delete <org-id> --yes
|
|
|
569
571
|
|
|
570
572
|
Create, inspect, update, and delete buckets. Buckets are top-level containers that hold objects
|
|
571
573
|
|
|
572
|
-
| Command
|
|
573
|
-
|
|
574
|
-
| `tigris buckets list` (l)
|
|
575
|
-
| `tigris buckets create` (c)
|
|
576
|
-
| `tigris buckets rebase`
|
|
577
|
-
| `tigris buckets merge`
|
|
578
|
-
| `tigris buckets get` (g)
|
|
579
|
-
| `tigris buckets delete` (d)
|
|
580
|
-
| `tigris buckets restore`
|
|
581
|
-
| `tigris buckets purge` (pg)
|
|
582
|
-
| `tigris buckets set` (s)
|
|
583
|
-
| `tigris buckets enable-snapshots`
|
|
584
|
-
| `tigris buckets disable-snapshots` | Disable snapshots on an existing bucket, converting it back to a regular bucket. Rejected while the bucket has dependent forks
|
|
585
|
-
| `tigris buckets set-locations`
|
|
586
|
-
| `tigris buckets set-migration`
|
|
587
|
-
| `tigris buckets migrate`
|
|
588
|
-
| `tigris buckets lifecycle` (lc)
|
|
589
|
-
| `tigris buckets set-notifications` | Configure object event notifications on a bucket. Sends webhook requests to a URL when objects are created, updated, or deleted
|
|
590
|
-
| `tigris buckets set-cors`
|
|
591
|
-
| `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 |
|
|
592
594
|
|
|
593
595
|
#### `tigris buckets list` (l)
|
|
594
596
|
|
|
@@ -598,15 +600,15 @@ List all buckets in the current organization
|
|
|
598
600
|
tigris buckets list [flags]
|
|
599
601
|
```
|
|
600
602
|
|
|
601
|
-
| Flag
|
|
602
|
-
|
|
603
|
-
| `--format`
|
|
604
|
-
| `--forks-of`
|
|
605
|
-
| `--deleted`
|
|
606
|
-
| `--forks-only`
|
|
607
|
-
| `--owner`
|
|
608
|
-
| `--limit`
|
|
609
|
-
| `-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 |
|
|
610
612
|
|
|
611
613
|
**Examples:**
|
|
612
614
|
```bash
|
|
@@ -626,16 +628,16 @@ Create a new bucket with optional access, tier, and location settings
|
|
|
626
628
|
tigris buckets create [name] [flags]
|
|
627
629
|
```
|
|
628
630
|
|
|
629
|
-
| Flag
|
|
630
|
-
|
|
631
|
-
| `-a, --access`
|
|
632
|
-
| `--public`
|
|
633
|
-
| `-s, --enable-snapshots`
|
|
634
|
-
| `--allow-object-acl`
|
|
635
|
-
| `--enable-directory-listing`
|
|
636
|
-
| `-t, --default-tier`
|
|
637
|
-
| `-l, --locations`
|
|
638
|
-
| `-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 |
|
|
639
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 |
|
|
640
642
|
|
|
641
643
|
**Examples:**
|
|
@@ -657,8 +659,8 @@ Update a fork with the latest changes from its source bucket
|
|
|
657
659
|
tigris buckets rebase <fork> [flags]
|
|
658
660
|
```
|
|
659
661
|
|
|
660
|
-
| Flag
|
|
661
|
-
|
|
662
|
+
| Flag | Description |
|
|
663
|
+
| ----------- | ------------------------- |
|
|
662
664
|
| `-y, --yes` | Skip confirmation prompts |
|
|
663
665
|
|
|
664
666
|
**Examples:**
|
|
@@ -675,10 +677,10 @@ Merge a fork's changes back into its source bucket
|
|
|
675
677
|
tigris buckets merge <fork> [flags]
|
|
676
678
|
```
|
|
677
679
|
|
|
678
|
-
| Flag
|
|
679
|
-
|
|
680
|
-
| `-y, --yes`
|
|
681
|
-
| `-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 |
|
|
682
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) |
|
|
683
685
|
|
|
684
686
|
**Examples:**
|
|
@@ -697,8 +699,8 @@ Show details for a bucket including access level, region, tier, and custom domai
|
|
|
697
699
|
tigris buckets get <name> [flags]
|
|
698
700
|
```
|
|
699
701
|
|
|
700
|
-
| Flag
|
|
701
|
-
|
|
702
|
+
| Flag | Description |
|
|
703
|
+
| ---------- | ------------------------------ |
|
|
702
704
|
| `--format` | Output format (default: table) |
|
|
703
705
|
|
|
704
706
|
**Examples:**
|
|
@@ -714,10 +716,10 @@ Delete one or more buckets by name. The bucket must be empty or delete-protectio
|
|
|
714
716
|
tigris buckets delete <name> [flags]
|
|
715
717
|
```
|
|
716
718
|
|
|
717
|
-
| Flag
|
|
718
|
-
|
|
719
|
-
| `-y, --yes` | Skip confirmation prompts
|
|
720
|
-
| `--force`
|
|
719
|
+
| Flag | Description |
|
|
720
|
+
| ----------- | ------------------------------------------- |
|
|
721
|
+
| `-y, --yes` | Skip confirmation prompts |
|
|
722
|
+
| `--force` | Skip confirmation prompts (alias for --yes) |
|
|
721
723
|
|
|
722
724
|
**Examples:**
|
|
723
725
|
```bash
|
|
@@ -746,10 +748,10 @@ Permanently destroy one or more soft-deleted buckets before their retention peri
|
|
|
746
748
|
tigris buckets purge <name> [flags]
|
|
747
749
|
```
|
|
748
750
|
|
|
749
|
-
| Flag
|
|
750
|
-
|
|
751
|
-
| `-y, --yes` | Skip confirmation prompts
|
|
752
|
-
| `--force`
|
|
751
|
+
| Flag | Description |
|
|
752
|
+
| ----------- | ------------------------------------------- |
|
|
753
|
+
| `-y, --yes` | Skip confirmation prompts |
|
|
754
|
+
| `--force` | Skip confirmation prompts (alias for --yes) |
|
|
753
755
|
|
|
754
756
|
**Examples:**
|
|
755
757
|
```bash
|
|
@@ -765,19 +767,19 @@ Update settings on an existing bucket such as access level, default tier, locati
|
|
|
765
767
|
tigris buckets set <name> [flags]
|
|
766
768
|
```
|
|
767
769
|
|
|
768
|
-
| Flag
|
|
769
|
-
|
|
770
|
-
| `--access`
|
|
771
|
-
| `--default-tier`
|
|
772
|
-
| `--locations`
|
|
773
|
-
| `--allow-object-acl`
|
|
774
|
-
| `--disable-directory-listing` | Disable directory listing
|
|
775
|
-
| `--cache-control`
|
|
776
|
-
| `--custom-domain`
|
|
777
|
-
| `--enable-delete-protection`
|
|
778
|
-
| `--soft-delete`
|
|
779
|
-
| `--retention-days`
|
|
780
|
-
| `--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) |
|
|
781
783
|
|
|
782
784
|
**Examples:**
|
|
783
785
|
```bash
|
|
@@ -823,8 +825,8 @@ Set the data locations for a bucket
|
|
|
823
825
|
tigris buckets set-locations <name> [flags]
|
|
824
826
|
```
|
|
825
827
|
|
|
826
|
-
| Flag
|
|
827
|
-
|
|
828
|
+
| Flag | Description |
|
|
829
|
+
| ----------------- | --------------- |
|
|
828
830
|
| `-l, --locations` | Bucket location |
|
|
829
831
|
|
|
830
832
|
**Examples:**
|
|
@@ -842,15 +844,15 @@ Configure data migration from an external S3-compatible source bucket. Tigris wi
|
|
|
842
844
|
tigris buckets set-migration <name> [flags]
|
|
843
845
|
```
|
|
844
846
|
|
|
845
|
-
| Flag
|
|
846
|
-
|
|
847
|
-
| `-b, --bucket`
|
|
848
|
-
| `-e, --endpoint`
|
|
849
|
-
| `-r, --region`
|
|
850
|
-
| `-key, --access-key`
|
|
851
|
-
| `-secret, --secret-key` | Secret key for the source bucket
|
|
852
|
-
| `--write-through`
|
|
853
|
-
| `--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 |
|
|
854
856
|
|
|
855
857
|
**Examples:**
|
|
856
858
|
```bash
|
|
@@ -867,8 +869,8 @@ Actively migrate all objects from a shadow bucket to Tigris by scheduling server
|
|
|
867
869
|
tigris buckets migrate <path> [flags]
|
|
868
870
|
```
|
|
869
871
|
|
|
870
|
-
| Flag
|
|
871
|
-
|
|
872
|
+
| Flag | Description |
|
|
873
|
+
| -------------------- | ---------------------------------------------------------------------------------------------------------- |
|
|
872
874
|
| `--max-in-flight-gb` | Max total gigabytes of scheduled-but-unconfirmed migrations to keep in flight. Accepts 1-100 (default: 50) |
|
|
873
875
|
|
|
874
876
|
**Examples:**
|
|
@@ -883,11 +885,11 @@ tigris buckets migrate my-bucket --max-in-flight-gb 100
|
|
|
883
885
|
|
|
884
886
|
Manage bucket lifecycle rules. Each rule combines an optional storage-class transition and/or expiration (TTL), scoped to an optional key prefix
|
|
885
887
|
|
|
886
|
-
| Command
|
|
887
|
-
|
|
888
|
-
| `tigris buckets lifecycle list` (l)
|
|
888
|
+
| Command | Description |
|
|
889
|
+
| ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
890
|
+
| `tigris buckets lifecycle list` (l) | List lifecycle rules on a bucket |
|
|
889
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 |
|
|
890
|
-
| `tigris buckets lifecycle edit` (e)
|
|
892
|
+
| `tigris buckets lifecycle edit` (e) | Edit an existing lifecycle rule by its id. Only specified fields are changed |
|
|
891
893
|
|
|
892
894
|
##### `tigris buckets lifecycle list` (l)
|
|
893
895
|
|
|
@@ -897,8 +899,8 @@ List lifecycle rules on a bucket
|
|
|
897
899
|
tigris buckets lifecycle list <name> [flags]
|
|
898
900
|
```
|
|
899
901
|
|
|
900
|
-
| Flag
|
|
901
|
-
|
|
902
|
+
| Flag | Description |
|
|
903
|
+
| ---------- | ------------------------------ |
|
|
902
904
|
| `--format` | Output format (default: table) |
|
|
903
905
|
|
|
904
906
|
**Examples:**
|
|
@@ -915,15 +917,15 @@ Create a new lifecycle rule. A rule must include a transition (--storage-class w
|
|
|
915
917
|
tigris buckets lifecycle create <name> [flags]
|
|
916
918
|
```
|
|
917
919
|
|
|
918
|
-
| Flag
|
|
919
|
-
|
|
920
|
-
| `-p, --prefix`
|
|
921
|
-
| `-s, --storage-class` | Target storage class for the transition
|
|
922
|
-
| `-d, --days`
|
|
923
|
-
| `--date`
|
|
924
|
-
| `--expire-days`
|
|
925
|
-
| `--expire-date`
|
|
926
|
-
| `--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 |
|
|
927
929
|
|
|
928
930
|
**Examples:**
|
|
929
931
|
```bash
|
|
@@ -941,16 +943,16 @@ Edit an existing lifecycle rule by its id. Only specified fields are changed
|
|
|
941
943
|
tigris buckets lifecycle edit <name> <id> [flags]
|
|
942
944
|
```
|
|
943
945
|
|
|
944
|
-
| Flag
|
|
945
|
-
|
|
946
|
-
| `-p, --prefix`
|
|
947
|
-
| `-s, --storage-class` | Replace the rule's transition target
|
|
948
|
-
| `-d, --days`
|
|
949
|
-
| `--date`
|
|
950
|
-
| `--expire-days`
|
|
951
|
-
| `--expire-date`
|
|
952
|
-
| `--enable`
|
|
953
|
-
| `--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) |
|
|
954
956
|
|
|
955
957
|
**Examples:**
|
|
956
958
|
```bash
|
|
@@ -967,16 +969,16 @@ Configure object event notifications on a bucket. Sends webhook requests to a UR
|
|
|
967
969
|
tigris buckets set-notifications <name> [flags]
|
|
968
970
|
```
|
|
969
971
|
|
|
970
|
-
| Flag
|
|
971
|
-
|
|
972
|
-
| `-u, --url`
|
|
972
|
+
| Flag | Description |
|
|
973
|
+
| -------------- | ---------------------------------------------------------------------------- |
|
|
974
|
+
| `-u, --url` | Webhook URL to send notifications to (must be http or https) |
|
|
973
975
|
| `-f, --filter` | SQL WHERE clause to filter events by key (e.g. WHERE `key` REGEXP "^images") |
|
|
974
|
-
| `-t, --token`
|
|
975
|
-
| `--username`
|
|
976
|
-
| `--password`
|
|
977
|
-
| `--enable`
|
|
978
|
-
| `--disable`
|
|
979
|
-
| `--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 |
|
|
980
982
|
|
|
981
983
|
**Examples:**
|
|
982
984
|
```bash
|
|
@@ -997,15 +999,15 @@ Configure CORS rules on a bucket. Each invocation adds a rule unless --override
|
|
|
997
999
|
tigris buckets set-cors <name> [flags]
|
|
998
1000
|
```
|
|
999
1001
|
|
|
1000
|
-
| Flag
|
|
1001
|
-
|
|
1002
|
-
| `-o, --origins`
|
|
1003
|
-
| `-m, --methods`
|
|
1004
|
-
| `--headers`
|
|
1005
|
-
| `--expose-headers` | Response headers to expose (comma-separated)
|
|
1006
|
-
| `--max-age`
|
|
1007
|
-
| `--override`
|
|
1008
|
-
| `--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 |
|
|
1009
1011
|
|
|
1010
1012
|
**Examples:**
|
|
1011
1013
|
```bash
|
|
@@ -1023,14 +1025,14 @@ Share a bucket with your whole organization, specific teams, or specific users.
|
|
|
1023
1025
|
tigris buckets share <name> [flags]
|
|
1024
1026
|
```
|
|
1025
1027
|
|
|
1026
|
-
| Flag
|
|
1027
|
-
|
|
1028
|
-
| `-org, --organization` | Give access to everyone in your organization. Takes exactly one --role and cannot be combined with --team or --user
|
|
1029
|
-
| `-t, --team`
|
|
1030
|
-
| `-u, --user`
|
|
1031
|
-
| `-r, --role`
|
|
1032
|
-
| `--override`
|
|
1033
|
-
| `--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 |
|
|
1034
1036
|
|
|
1035
1037
|
**Examples:**
|
|
1036
1038
|
```bash
|
|
@@ -1046,10 +1048,10 @@ tigris buckets share my-bucket --reset
|
|
|
1046
1048
|
|
|
1047
1049
|
List, take, and delete snapshots. A snapshot is a point-in-time, read-only copy of a bucket's state
|
|
1048
1050
|
|
|
1049
|
-
| Command
|
|
1050
|
-
|
|
1051
|
-
| `tigris snapshots list` (l)
|
|
1052
|
-
| `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 |
|
|
1053
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 |
|
|
1054
1056
|
|
|
1055
1057
|
#### `tigris snapshots list` (l)
|
|
@@ -1060,10 +1062,10 @@ List all snapshots for the given bucket, ordered by creation time
|
|
|
1060
1062
|
tigris snapshots list <name> [flags]
|
|
1061
1063
|
```
|
|
1062
1064
|
|
|
1063
|
-
| Flag
|
|
1064
|
-
|
|
1065
|
-
| `--format`
|
|
1066
|
-
| `--limit`
|
|
1065
|
+
| Flag | Description |
|
|
1066
|
+
| ------------------- | --------------------------------------------------------------- |
|
|
1067
|
+
| `--format` | Output format (default: table) |
|
|
1068
|
+
| `--limit` | Maximum number of items to return per page |
|
|
1067
1069
|
| `-pt, --page-token` | Pagination token from a previous request to fetch the next page |
|
|
1068
1070
|
|
|
1069
1071
|
**Examples:**
|
|
@@ -1094,10 +1096,10 @@ Delete one or more snapshots of a bucket by version. Deletion is permanent; fork
|
|
|
1094
1096
|
tigris snapshots delete <name> <version> [flags]
|
|
1095
1097
|
```
|
|
1096
1098
|
|
|
1097
|
-
| Flag
|
|
1098
|
-
|
|
1099
|
-
| `-y, --yes` | Skip confirmation prompts
|
|
1100
|
-
| `--force`
|
|
1099
|
+
| Flag | Description |
|
|
1100
|
+
| ----------- | ------------------------------------------- |
|
|
1101
|
+
| `-y, --yes` | Skip confirmation prompts |
|
|
1102
|
+
| `--force` | Skip confirmation prompts (alias for --yes) |
|
|
1101
1103
|
|
|
1102
1104
|
**Examples:**
|
|
1103
1105
|
```bash
|
|
@@ -1109,20 +1111,20 @@ tigris snapshots delete my-bucket 1765889000501544464,1765889000501544465 --yes
|
|
|
1109
1111
|
|
|
1110
1112
|
Low-level object operations for listing, downloading, uploading, and deleting individual objects in a bucket
|
|
1111
1113
|
|
|
1112
|
-
| Command
|
|
1113
|
-
|
|
1114
|
-
| `tigris objects list` (l)
|
|
1115
|
-
| `tigris objects list-versions` (lv)
|
|
1116
|
-
| `tigris objects get` (g)
|
|
1117
|
-
| `tigris objects put` (p)
|
|
1118
|
-
| `tigris objects delete` (d)
|
|
1119
|
-
| `tigris objects set` (s)
|
|
1120
|
-
| `tigris objects set-access` (sa)
|
|
1121
|
-
| `tigris objects info` (i)
|
|
1122
|
-
| `tigris objects restore` (rs)
|
|
1123
|
-
| `tigris objects restore-info` (ri)
|
|
1124
|
-
| `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"
|
|
1125
|
-
| `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" |
|
|
1126
1128
|
|
|
1127
1129
|
#### `tigris objects list` (l)
|
|
1128
1130
|
|
|
@@ -1132,15 +1134,15 @@ List objects in a bucket, optionally filtered by a key prefix
|
|
|
1132
1134
|
tigris objects list <bucket> [flags]
|
|
1133
1135
|
```
|
|
1134
1136
|
|
|
1135
|
-
| Flag
|
|
1136
|
-
|
|
1137
|
-
| `-p, --prefix`
|
|
1138
|
-
| `--format`
|
|
1139
|
-
| `-snapshot, --snapshot-version` | Read from a specific bucket snapshot. Accepts a snapshot version string or any UNIX nanosecond-precision timestamp (e.g. 1765889000501544464)
|
|
1140
|
-
| `--limit`
|
|
1141
|
-
| `-pt, --page-token`
|
|
1142
|
-
| `--source`
|
|
1143
|
-
| `--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 |
|
|
1144
1146
|
|
|
1145
1147
|
**Examples:**
|
|
1146
1148
|
```bash
|
|
@@ -1160,15 +1162,15 @@ List object versions and delete markers in a bucket (requires bucket versioning)
|
|
|
1160
1162
|
tigris objects list-versions <bucket> [flags]
|
|
1161
1163
|
```
|
|
1162
1164
|
|
|
1163
|
-
| Flag
|
|
1164
|
-
|
|
1165
|
-
| `-p, --prefix`
|
|
1166
|
-
| `-d, --delimiter`
|
|
1167
|
-
| `--format`
|
|
1168
|
-
| `--limit`
|
|
1169
|
-
| `--key-marker`
|
|
1170
|
-
| `--version-id-marker` | Pagination marker — the version id to start listing from (from a prior nextVersionIdMarker)
|
|
1171
|
-
| `--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" |
|
|
1172
1174
|
|
|
1173
1175
|
**Examples:**
|
|
1174
1176
|
```bash
|
|
@@ -1187,12 +1189,12 @@ Download an object by key. Prints to stdout by default, or saves to a file with
|
|
|
1187
1189
|
tigris objects get <bucket> [key] [flags]
|
|
1188
1190
|
```
|
|
1189
1191
|
|
|
1190
|
-
| Flag
|
|
1191
|
-
|
|
1192
|
-
| `-o, --output`
|
|
1193
|
-
| `-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) |
|
|
1194
1196
|
| `-snapshot, --snapshot-version` | Read from a specific bucket snapshot. Accepts a snapshot version string or any UNIX nanosecond-precision timestamp (e.g. 1765889000501544464) |
|
|
1195
|
-
| `--version-id`
|
|
1197
|
+
| `--version-id` | Object version id to download (requires bucket versioning). Omit to download the latest version |
|
|
1196
1198
|
|
|
1197
1199
|
**Examples:**
|
|
1198
1200
|
```bash
|
|
@@ -1209,12 +1211,12 @@ Upload a local file — or data piped via stdin — as an object. Content-type i
|
|
|
1209
1211
|
tigris objects put <bucket> [key] [file] [flags]
|
|
1210
1212
|
```
|
|
1211
1213
|
|
|
1212
|
-
| Flag
|
|
1213
|
-
|
|
1214
|
-
| `-a, --access`
|
|
1215
|
-
| `-t, --content-type` | Content type (auto-detected from extension if omitted)
|
|
1216
|
-
| `--cache-control`
|
|
1217
|
-
| `--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) |
|
|
1218
1220
|
|
|
1219
1221
|
**Examples:**
|
|
1220
1222
|
```bash
|
|
@@ -1234,12 +1236,12 @@ Delete one or more objects by key from the given bucket. On a versioned bucket,
|
|
|
1234
1236
|
tigris objects delete <bucket> [key] [flags]
|
|
1235
1237
|
```
|
|
1236
1238
|
|
|
1237
|
-
| Flag
|
|
1238
|
-
|
|
1239
|
-
| `-y, --yes`
|
|
1240
|
-
| `--version-id`
|
|
1241
|
-
| `--all-versions` | Hard-delete every version and delete marker for the given key(s). Mutually exclusive with --version-id
|
|
1242
|
-
| `--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) |
|
|
1243
1245
|
|
|
1244
1246
|
**Examples:**
|
|
1245
1247
|
```bash
|
|
@@ -1258,9 +1260,9 @@ tigris objects delete my-bucket old-file.txt --all-versions --yes
|
|
|
1258
1260
|
tigris objects set <bucket> [key] [flags]
|
|
1259
1261
|
```
|
|
1260
1262
|
|
|
1261
|
-
| Flag
|
|
1262
|
-
|
|
1263
|
-
| `-a, --access`
|
|
1263
|
+
| Flag | Description |
|
|
1264
|
+
| --------------- | ------------------------------ |
|
|
1265
|
+
| `-a, --access` | Access level **(required)** |
|
|
1264
1266
|
| `-n, --new-key` | Rename the object to a new key |
|
|
1265
1267
|
|
|
1266
1268
|
**Examples:**
|
|
@@ -1278,8 +1280,8 @@ Set the access level (public or private) on an existing object
|
|
|
1278
1280
|
tigris objects set-access <bucket> [key] [access] [flags]
|
|
1279
1281
|
```
|
|
1280
1282
|
|
|
1281
|
-
| Flag
|
|
1282
|
-
|
|
1283
|
+
| Flag | Description |
|
|
1284
|
+
| ---------- | ------------------------------ |
|
|
1283
1285
|
| `--format` | Output format (default: table) |
|
|
1284
1286
|
|
|
1285
1287
|
**Examples:**
|
|
@@ -1296,11 +1298,11 @@ Show metadata for an object (content type, size, modified date)
|
|
|
1296
1298
|
tigris objects info <bucket> [key] [flags]
|
|
1297
1299
|
```
|
|
1298
1300
|
|
|
1299
|
-
| Flag
|
|
1300
|
-
|
|
1301
|
-
| `--format`
|
|
1302
|
-
| `-snapshot, --snapshot-version` | Read from a specific bucket snapshot
|
|
1303
|
-
| `--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 |
|
|
1304
1306
|
|
|
1305
1307
|
**Examples:**
|
|
1306
1308
|
```bash
|
|
@@ -1318,12 +1320,12 @@ Restore an archived object (e.g. one in the GLACIER tier) into an actively-reada
|
|
|
1318
1320
|
tigris objects restore <bucket> [key] [flags]
|
|
1319
1321
|
```
|
|
1320
1322
|
|
|
1321
|
-
| Flag
|
|
1322
|
-
|
|
1323
|
-
| `-d, --days`
|
|
1324
|
-
| `--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 |
|
|
1325
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) |
|
|
1326
|
-
| `--format`
|
|
1328
|
+
| `--format` | Output format (default: table) |
|
|
1327
1329
|
|
|
1328
1330
|
**Examples:**
|
|
1329
1331
|
```bash
|
|
@@ -1341,11 +1343,11 @@ Show the restore state of an archived object (archived, in-progress, or restored
|
|
|
1341
1343
|
tigris objects restore-info <bucket> [key] [flags]
|
|
1342
1344
|
```
|
|
1343
1345
|
|
|
1344
|
-
| Flag
|
|
1345
|
-
|
|
1346
|
-
| `--version-id`
|
|
1346
|
+
| Flag | Description |
|
|
1347
|
+
| ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1348
|
+
| `--version-id` | Inspect a specific object version (requires bucket versioning). Omit to read the current version |
|
|
1347
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) |
|
|
1348
|
-
| `--format`
|
|
1350
|
+
| `--format` | Output format (default: table) |
|
|
1349
1351
|
|
|
1350
1352
|
**Examples:**
|
|
1351
1353
|
```bash
|
|
@@ -1362,10 +1364,10 @@ Restore a soft-deleted object within its retention window. List recoverable obje
|
|
|
1362
1364
|
tigris objects restore-deleted <bucket> [key] [flags]
|
|
1363
1365
|
```
|
|
1364
1366
|
|
|
1365
|
-
| Flag
|
|
1366
|
-
|
|
1367
|
+
| Flag | Description |
|
|
1368
|
+
| -------------- | ---------------------------------------------------------------------------------------------------- |
|
|
1367
1369
|
| `--version-id` | The soft-deleted version to bring back, from "tigris objects list-versions --deleted" **(required)** |
|
|
1368
|
-
| `--format`
|
|
1370
|
+
| `--format` | Output format (default: table) |
|
|
1369
1371
|
|
|
1370
1372
|
**Examples:**
|
|
1371
1373
|
```bash
|
|
@@ -1381,12 +1383,12 @@ Permanently destroy a soft-deleted object version before its retention period ex
|
|
|
1381
1383
|
tigris objects purge <bucket> [key] [flags]
|
|
1382
1384
|
```
|
|
1383
1385
|
|
|
1384
|
-
| Flag
|
|
1385
|
-
|
|
1386
|
-
| `-y, --yes`
|
|
1386
|
+
| Flag | Description |
|
|
1387
|
+
| -------------- | ------------------------------------------------------------------------------------------------- |
|
|
1388
|
+
| `-y, --yes` | Skip confirmation prompts |
|
|
1387
1389
|
| `--version-id` | The soft-deleted version to destroy, from "tigris objects list-versions --deleted" **(required)** |
|
|
1388
|
-
| `--force`
|
|
1389
|
-
| `--format`
|
|
1390
|
+
| `--force` | Skip confirmation prompts (alias for --yes) |
|
|
1391
|
+
| `--format` | Output format (default: table) |
|
|
1390
1392
|
|
|
1391
1393
|
**Examples:**
|
|
1392
1394
|
```bash
|
|
@@ -1398,18 +1400,18 @@ tigris objects purge t3://my-bucket/report.pdf --version-id 1787749774802410496
|
|
|
1398
1400
|
|
|
1399
1401
|
Create, list, inspect, delete, and assign roles to access keys. Access keys are credentials used for programmatic API access
|
|
1400
1402
|
|
|
1401
|
-
| Command
|
|
1402
|
-
|
|
1403
|
-
| `tigris access-keys list` (l)
|
|
1404
|
-
| `tigris access-keys create` (c)
|
|
1405
|
-
| `tigris access-keys delete` (d)
|
|
1406
|
-
| `tigris access-keys get` (g)
|
|
1407
|
-
| `tigris access-keys assign` (a)
|
|
1408
|
-
| `tigris access-keys set` (s)
|
|
1409
|
-
| `tigris access-keys rotate` (r)
|
|
1410
|
-
| `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
|
|
1411
|
-
| `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
|
|
1412
|
-
| `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 |
|
|
1413
1415
|
|
|
1414
1416
|
#### `tigris access-keys list` (l)
|
|
1415
1417
|
|
|
@@ -1419,10 +1421,10 @@ List all access keys in the current organization
|
|
|
1419
1421
|
tigris access-keys list [flags]
|
|
1420
1422
|
```
|
|
1421
1423
|
|
|
1422
|
-
| Flag
|
|
1423
|
-
|
|
1424
|
-
| `--format`
|
|
1425
|
-
| `--limit`
|
|
1424
|
+
| Flag | Description |
|
|
1425
|
+
| ------------------- | --------------------------------------------------------------- |
|
|
1426
|
+
| `--format` | Output format (default: table) |
|
|
1427
|
+
| `--limit` | Maximum number of items to return per page |
|
|
1426
1428
|
| `-pt, --page-token` | Pagination token from a previous request to fetch the next page |
|
|
1427
1429
|
|
|
1428
1430
|
**Examples:**
|
|
@@ -1438,15 +1440,15 @@ Create a new access key, optionally scoped to buckets, and export its credential
|
|
|
1438
1440
|
tigris access-keys create <name> [flags]
|
|
1439
1441
|
```
|
|
1440
1442
|
|
|
1441
|
-
| Flag
|
|
1442
|
-
|
|
1443
|
-
| `-b, --bucket`
|
|
1444
|
-
| `-r, --role`
|
|
1445
|
-
| `--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 |
|
|
1446
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 |
|
|
1447
|
-
| `--env`
|
|
1448
|
-
| `--export`
|
|
1449
|
-
| `--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) |
|
|
1450
1452
|
|
|
1451
1453
|
**Examples:**
|
|
1452
1454
|
```bash
|
|
@@ -1464,10 +1466,10 @@ Permanently delete one or more access keys by ID. This revokes all access immedi
|
|
|
1464
1466
|
tigris access-keys delete <id> [flags]
|
|
1465
1467
|
```
|
|
1466
1468
|
|
|
1467
|
-
| Flag
|
|
1468
|
-
|
|
1469
|
-
| `-y, --yes` | Skip confirmation prompts
|
|
1470
|
-
| `--force`
|
|
1469
|
+
| Flag | Description |
|
|
1470
|
+
| ----------- | ------------------------------------------- |
|
|
1471
|
+
| `-y, --yes` | Skip confirmation prompts |
|
|
1472
|
+
| `--force` | Skip confirmation prompts (alias for --yes) |
|
|
1471
1473
|
|
|
1472
1474
|
**Examples:**
|
|
1473
1475
|
```bash
|
|
@@ -1496,12 +1498,12 @@ Assign per-bucket roles to an access key. Pair each --bucket with a --role (Edit
|
|
|
1496
1498
|
tigris access-keys assign <id> [flags]
|
|
1497
1499
|
```
|
|
1498
1500
|
|
|
1499
|
-
| Flag
|
|
1500
|
-
|
|
1501
|
-
| `-b, --bucket`
|
|
1502
|
-
| `-r, --role`
|
|
1503
|
-
| `--admin`
|
|
1504
|
-
| `--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 |
|
|
1505
1507
|
|
|
1506
1508
|
**Examples:**
|
|
1507
1509
|
```bash
|
|
@@ -1519,8 +1521,8 @@ Update settings on an existing access key — currently its default permissions,
|
|
|
1519
1521
|
tigris access-keys set <id> [flags]
|
|
1520
1522
|
```
|
|
1521
1523
|
|
|
1522
|
-
| Flag
|
|
1523
|
-
|
|
1524
|
+
| Flag | Description |
|
|
1525
|
+
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1524
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 |
|
|
1525
1527
|
|
|
1526
1528
|
**Examples:**
|
|
@@ -1537,10 +1539,10 @@ Rotate an access key's secret. The current secret is immediately invalidated and
|
|
|
1537
1539
|
tigris access-keys rotate <id> [flags]
|
|
1538
1540
|
```
|
|
1539
1541
|
|
|
1540
|
-
| Flag
|
|
1541
|
-
|
|
1542
|
-
| `-y, --yes` | Skip confirmation prompts
|
|
1543
|
-
| `--force`
|
|
1542
|
+
| Flag | Description |
|
|
1543
|
+
| ----------- | ------------------------------------------- |
|
|
1544
|
+
| `-y, --yes` | Skip confirmation prompts |
|
|
1545
|
+
| `--force` | Skip confirmation prompts (alias for --yes) |
|
|
1544
1546
|
|
|
1545
1547
|
**Examples:**
|
|
1546
1548
|
```bash
|
|
@@ -1555,8 +1557,8 @@ Attach an IAM policy to an access key. If no policy ARN is provided, shows inter
|
|
|
1555
1557
|
tigris access-keys attach-policy <id> [flags]
|
|
1556
1558
|
```
|
|
1557
1559
|
|
|
1558
|
-
| Flag
|
|
1559
|
-
|
|
1560
|
+
| Flag | Description |
|
|
1561
|
+
| -------------- | --------------------------- |
|
|
1560
1562
|
| `--policy-arn` | ARN of the policy to attach |
|
|
1561
1563
|
|
|
1562
1564
|
**Examples:**
|
|
@@ -1573,11 +1575,11 @@ Detach an IAM policy from an access key. If no policy ARN is provided, shows int
|
|
|
1573
1575
|
tigris access-keys detach-policy <id> [flags]
|
|
1574
1576
|
```
|
|
1575
1577
|
|
|
1576
|
-
| Flag
|
|
1577
|
-
|
|
1578
|
-
| `-y, --yes`
|
|
1579
|
-
| `--policy-arn` | ARN of the policy to detach
|
|
1580
|
-
| `--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) |
|
|
1581
1583
|
|
|
1582
1584
|
**Examples:**
|
|
1583
1585
|
```bash
|
|
@@ -1593,10 +1595,10 @@ List all IAM policies attached to an access key
|
|
|
1593
1595
|
tigris access-keys list-policies <id> [flags]
|
|
1594
1596
|
```
|
|
1595
1597
|
|
|
1596
|
-
| Flag
|
|
1597
|
-
|
|
1598
|
-
| `--format`
|
|
1599
|
-
| `--limit`
|
|
1598
|
+
| Flag | Description |
|
|
1599
|
+
| ------------------- | --------------------------------------------------------------- |
|
|
1600
|
+
| `--format` | Output format (default: table) |
|
|
1601
|
+
| `--limit` | Maximum number of items to return per page |
|
|
1600
1602
|
| `-pt, --page-token` | Pagination token from a previous request to fetch the next page |
|
|
1601
1603
|
|
|
1602
1604
|
**Examples:**
|
|
@@ -1608,26 +1610,26 @@ tigris access-keys list-policies tid_AaBbCcDdEeFf
|
|
|
1608
1610
|
|
|
1609
1611
|
Identity and Access Management - manage policies, users, and permissions
|
|
1610
1612
|
|
|
1611
|
-
| Command
|
|
1612
|
-
|
|
1613
|
+
| Command | Description |
|
|
1614
|
+
| ------------------------- | ---------------------------------------------------------------- |
|
|
1613
1615
|
| `tigris iam policies` (p) | Manage IAM policies. Policies define permissions for access keys |
|
|
1614
|
-
| `tigris iam users` (u)
|
|
1615
|
-
| `tigris iam teams` (t)
|
|
1616
|
+
| `tigris iam users` (u) | Manage organization users and invitations |
|
|
1617
|
+
| `tigris iam teams` (t) | Manage organization teams |
|
|
1616
1618
|
|
|
1617
1619
|
#### `tigris iam policies` (p)
|
|
1618
1620
|
|
|
1619
1621
|
Manage IAM policies. Policies define permissions for access keys
|
|
1620
1622
|
|
|
1621
|
-
| Command
|
|
1622
|
-
|
|
1623
|
-
| `tigris iam policies list` (l)
|
|
1624
|
-
| `tigris iam policies get` (g)
|
|
1625
|
-
| `tigris iam policies create` (c)
|
|
1626
|
-
| `tigris iam policies edit` (e)
|
|
1627
|
-
| `tigris iam policies delete` (d)
|
|
1628
|
-
| `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 |
|
|
1629
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 |
|
|
1630
|
-
| `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 |
|
|
1631
1633
|
|
|
1632
1634
|
##### `tigris iam policies list` (l)
|
|
1633
1635
|
|
|
@@ -1637,10 +1639,10 @@ List all policies in the current organization
|
|
|
1637
1639
|
tigris iam policies list [flags]
|
|
1638
1640
|
```
|
|
1639
1641
|
|
|
1640
|
-
| Flag
|
|
1641
|
-
|
|
1642
|
-
| `--format`
|
|
1643
|
-
| `--limit`
|
|
1642
|
+
| Flag | Description |
|
|
1643
|
+
| ------------------- | --------------------------------------------------------------- |
|
|
1644
|
+
| `--format` | Output format (default: table) |
|
|
1645
|
+
| `--limit` | Maximum number of items to return per page |
|
|
1644
1646
|
| `-pt, --page-token` | Pagination token from a previous request to fetch the next page |
|
|
1645
1647
|
|
|
1646
1648
|
**Examples:**
|
|
@@ -1656,8 +1658,8 @@ Show details for a policy including its document and attached users. If no ARN p
|
|
|
1656
1658
|
tigris iam policies get [resource] [flags]
|
|
1657
1659
|
```
|
|
1658
1660
|
|
|
1659
|
-
| Flag
|
|
1660
|
-
|
|
1661
|
+
| Flag | Description |
|
|
1662
|
+
| ---------- | ------------------------------ |
|
|
1661
1663
|
| `--format` | Output format (default: table) |
|
|
1662
1664
|
|
|
1663
1665
|
**Examples:**
|
|
@@ -1674,10 +1676,10 @@ Create a new policy with the given name and policy document. Document can be pro
|
|
|
1674
1676
|
tigris iam policies create <name> [flags]
|
|
1675
1677
|
```
|
|
1676
1678
|
|
|
1677
|
-
| Flag
|
|
1678
|
-
|
|
1679
|
+
| Flag | Description |
|
|
1680
|
+
| ---------------- | ----------------------------------------------------------------------------- |
|
|
1679
1681
|
| `-d, --document` | Policy document (JSON file path or inline JSON). If omitted, reads from stdin |
|
|
1680
|
-
| `--description`
|
|
1682
|
+
| `--description` | Policy description |
|
|
1681
1683
|
|
|
1682
1684
|
**Examples:**
|
|
1683
1685
|
```bash
|
|
@@ -1694,10 +1696,10 @@ Update an existing policy's document. Document can be provided via file, inline
|
|
|
1694
1696
|
tigris iam policies edit [resource] [flags]
|
|
1695
1697
|
```
|
|
1696
1698
|
|
|
1697
|
-
| Flag
|
|
1698
|
-
|
|
1699
|
+
| Flag | Description |
|
|
1700
|
+
| ---------------- | --------------------------------------------------------------------------------- |
|
|
1699
1701
|
| `-d, --document` | New policy document (JSON file path or inline JSON). If omitted, reads from stdin |
|
|
1700
|
-
| `--description`
|
|
1702
|
+
| `--description` | Update policy description |
|
|
1701
1703
|
|
|
1702
1704
|
**Examples:**
|
|
1703
1705
|
```bash
|
|
@@ -1714,10 +1716,10 @@ Delete a policy. If no ARN provided, shows interactive selection
|
|
|
1714
1716
|
tigris iam policies delete [resource] [flags]
|
|
1715
1717
|
```
|
|
1716
1718
|
|
|
1717
|
-
| Flag
|
|
1718
|
-
|
|
1719
|
-
| `-y, --yes` | Skip confirmation prompts
|
|
1720
|
-
| `--force`
|
|
1719
|
+
| Flag | Description |
|
|
1720
|
+
| ----------- | ------------------------------------------- |
|
|
1721
|
+
| `-y, --yes` | Skip confirmation prompts |
|
|
1722
|
+
| `--force` | Skip confirmation prompts (alias for --yes) |
|
|
1721
1723
|
|
|
1722
1724
|
**Examples:**
|
|
1723
1725
|
```bash
|
|
@@ -1733,8 +1735,8 @@ Link an access key to a policy. If no policy ARN is provided, shows interactive
|
|
|
1733
1735
|
tigris iam policies link-key [resource] [flags]
|
|
1734
1736
|
```
|
|
1735
1737
|
|
|
1736
|
-
| Flag
|
|
1737
|
-
|
|
1738
|
+
| Flag | Description |
|
|
1739
|
+
| ------ | ----------------------- |
|
|
1738
1740
|
| `--id` | Access key ID to attach |
|
|
1739
1741
|
|
|
1740
1742
|
**Examples:**
|
|
@@ -1751,11 +1753,11 @@ Unlink an access key from a policy. If no policy ARN is provided, shows interact
|
|
|
1751
1753
|
tigris iam policies unlink-key [resource] [flags]
|
|
1752
1754
|
```
|
|
1753
1755
|
|
|
1754
|
-
| Flag
|
|
1755
|
-
|
|
1756
|
-
| `-y, --yes` | Skip confirmation prompts
|
|
1757
|
-
| `--id`
|
|
1758
|
-
| `--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) |
|
|
1759
1761
|
|
|
1760
1762
|
**Examples:**
|
|
1761
1763
|
```bash
|
|
@@ -1771,8 +1773,8 @@ List all access keys attached to a policy. If no policy ARN is provided, shows i
|
|
|
1771
1773
|
tigris iam policies list-keys [resource] [flags]
|
|
1772
1774
|
```
|
|
1773
1775
|
|
|
1774
|
-
| Flag
|
|
1775
|
-
|
|
1776
|
+
| Flag | Description |
|
|
1777
|
+
| ---------- | ------------------------------ |
|
|
1776
1778
|
| `--format` | Output format (default: table) |
|
|
1777
1779
|
|
|
1778
1780
|
**Examples:**
|
|
@@ -1785,13 +1787,13 @@ tigris iam policies list-keys
|
|
|
1785
1787
|
|
|
1786
1788
|
Manage organization users and invitations
|
|
1787
1789
|
|
|
1788
|
-
| Command
|
|
1789
|
-
|
|
1790
|
-
| `tigris iam users list` (l)
|
|
1791
|
-
| `tigris iam users invite` (i)
|
|
1792
|
-
| `tigris iam users revoke-invitation` (ri) | Revoke pending invitations. If no invitation ID provided, shows interactive selection
|
|
1793
|
-
| `tigris iam users update-role` (ur)
|
|
1794
|
-
| `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 |
|
|
1795
1797
|
|
|
1796
1798
|
##### `tigris iam users list` (l)
|
|
1797
1799
|
|
|
@@ -1801,8 +1803,8 @@ List all users and pending invitations in the organization
|
|
|
1801
1803
|
tigris iam users list [flags]
|
|
1802
1804
|
```
|
|
1803
1805
|
|
|
1804
|
-
| Flag
|
|
1805
|
-
|
|
1806
|
+
| Flag | Description |
|
|
1807
|
+
| ---------- | ------------------------------ |
|
|
1806
1808
|
| `--format` | Output format (default: table) |
|
|
1807
1809
|
|
|
1808
1810
|
**Examples:**
|
|
@@ -1819,8 +1821,8 @@ Invite users to the organization by email
|
|
|
1819
1821
|
tigris iam users invite <email> [flags]
|
|
1820
1822
|
```
|
|
1821
1823
|
|
|
1822
|
-
| Flag
|
|
1823
|
-
|
|
1824
|
+
| Flag | Description |
|
|
1825
|
+
| ------------ | ------------------------------------------------------- |
|
|
1824
1826
|
| `-r, --role` | Role to assign to the invited user(s) (default: member) |
|
|
1825
1827
|
|
|
1826
1828
|
**Examples:**
|
|
@@ -1838,10 +1840,10 @@ Revoke pending invitations. If no invitation ID provided, shows interactive sele
|
|
|
1838
1840
|
tigris iam users revoke-invitation [resource] [flags]
|
|
1839
1841
|
```
|
|
1840
1842
|
|
|
1841
|
-
| Flag
|
|
1842
|
-
|
|
1843
|
-
| `-y, --yes` | Skip confirmation prompts
|
|
1844
|
-
| `--force`
|
|
1843
|
+
| Flag | Description |
|
|
1844
|
+
| ----------- | ------------------------------------------- |
|
|
1845
|
+
| `-y, --yes` | Skip confirmation prompts |
|
|
1846
|
+
| `--force` | Skip confirmation prompts (alias for --yes) |
|
|
1845
1847
|
|
|
1846
1848
|
**Examples:**
|
|
1847
1849
|
```bash
|
|
@@ -1858,8 +1860,8 @@ Update user roles in the organization. If no user ID provided, shows interactive
|
|
|
1858
1860
|
tigris iam users update-role [resource] [flags]
|
|
1859
1861
|
```
|
|
1860
1862
|
|
|
1861
|
-
| Flag
|
|
1862
|
-
|
|
1863
|
+
| Flag | Description |
|
|
1864
|
+
| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1863
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)** |
|
|
1864
1866
|
|
|
1865
1867
|
**Examples:**
|
|
@@ -1878,10 +1880,10 @@ Remove users from the organization. If no user ID provided, shows interactive se
|
|
|
1878
1880
|
tigris iam users remove [resource] [flags]
|
|
1879
1881
|
```
|
|
1880
1882
|
|
|
1881
|
-
| Flag
|
|
1882
|
-
|
|
1883
|
-
| `-y, --yes` | Skip confirmation prompts
|
|
1884
|
-
| `--force`
|
|
1883
|
+
| Flag | Description |
|
|
1884
|
+
| ----------- | ------------------------------------------- |
|
|
1885
|
+
| `-y, --yes` | Skip confirmation prompts |
|
|
1886
|
+
| `--force` | Skip confirmation prompts (alias for --yes) |
|
|
1885
1887
|
|
|
1886
1888
|
**Examples:**
|
|
1887
1889
|
```bash
|
|
@@ -1894,11 +1896,11 @@ tigris iam users remove user@example.com,user@example.net --yes
|
|
|
1894
1896
|
|
|
1895
1897
|
Manage organization teams
|
|
1896
1898
|
|
|
1897
|
-
| Command
|
|
1898
|
-
|
|
1899
|
-
| `tigris iam teams list` (l)
|
|
1900
|
-
| `tigris iam teams create` (c) | Create a new team in the organization
|
|
1901
|
-
| `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 |
|
|
1902
1904
|
|
|
1903
1905
|
##### `tigris iam teams list` (l)
|
|
1904
1906
|
|
|
@@ -1908,8 +1910,8 @@ List all teams in the organization
|
|
|
1908
1910
|
tigris iam teams list [flags]
|
|
1909
1911
|
```
|
|
1910
1912
|
|
|
1911
|
-
| Flag
|
|
1912
|
-
|
|
1913
|
+
| Flag | Description |
|
|
1914
|
+
| ---------- | ------------------------------ |
|
|
1913
1915
|
| `--format` | Output format (default: table) |
|
|
1914
1916
|
|
|
1915
1917
|
**Examples:**
|
|
@@ -1926,10 +1928,10 @@ Create a new team in the organization
|
|
|
1926
1928
|
tigris iam teams create <name> [flags]
|
|
1927
1929
|
```
|
|
1928
1930
|
|
|
1929
|
-
| Flag
|
|
1930
|
-
|
|
1931
|
-
| `-d, --description` | Description for the team
|
|
1932
|
-
| `-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) |
|
|
1933
1935
|
|
|
1934
1936
|
**Examples:**
|
|
1935
1937
|
```bash
|
|
@@ -1946,11 +1948,11 @@ Update a team's name, description, or members. Members are replaced with the pro
|
|
|
1946
1948
|
tigris iam teams edit <id> [flags]
|
|
1947
1949
|
```
|
|
1948
1950
|
|
|
1949
|
-
| Flag
|
|
1950
|
-
|
|
1951
|
-
| `-n, --name`
|
|
1952
|
-
| `-d, --description` | New description for the team
|
|
1953
|
-
| `-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) |
|
|
1954
1956
|
|
|
1955
1957
|
**Examples:**
|
|
1956
1958
|
```bash
|
|
@@ -1973,6 +1975,26 @@ tigris telemetry enable
|
|
|
1973
1975
|
`TIGRIS_NO_TELEMETRY=1` or `DO_NOT_TRACK=1` also disable it and take precedence
|
|
1974
1976
|
over the stored setting. Telemetry is off in development builds and test runs.
|
|
1975
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
|
+
|
|
1976
1998
|
## License
|
|
1977
1999
|
|
|
1978
2000
|
MIT
|