Tigris

https://www.tigrisdata.com/docs
Admin
Tigris is a globally distributed, multi-cloud object storage service with S3 API compatibility,...
Tokens:525,188
Snippets:4,419
Trust Score:8.7
Update:16 hours ago
Show doc for...
Tokens:
Raw
### Examples: tigris init, npx tigris init, tigris init --agent

Source: https://www.tigrisdata.com/docs/cli/init/

Three ways to run the init command: interactive setup, without installing the CLI first via npx, and letting the agent run the setup with --agent.

```bash
# Interactive setup
tigris init

# Without installing the CLI first
npx tigris init

# Let the agent run the setup
tigris init --agent
```

--------------------------------

### Install storage-go with go get

Source: https://www.tigrisdata.com/docs/changelog/

Install the official Tigris Go SDK using the go get command.

```bash
go get github.com/tigrisdata/storage-go@latest
```

--------------------------------

### Examples: Generate presigned URLs

Source: https://www.tigrisdata.com/docs/cli/presign/

A set of example commands demonstrating various use cases: default GET URL, PUT with custom expiry, JSON output, specific access key, piping to clipboard, and snapshot version. Each example is a separate command.

```bash
# Generate a presigned GET URL (default 1 hour expiry)
tigris presign my-bucket/file.txt
```

```bash
# Generate a presigned PUT URL with 2 hour expiry
tigris presign t3://my-bucket/report.pdf --method put --expires-in 7200
```

```bash
# Output as JSON
tigris presign my-bucket/image.png --format json
```

```bash
# Use a specific access key
tigris presign my-bucket/data.csv --access-key tid_AaBb
```

```bash
# Pipe the URL to clipboard
tigris presign my-bucket/file.txt | pbcopy
```

```bash
# Link to the object as it was in a snapshot
tigris presign my-bucket/file.txt --snapshot-version 1765889000501544464
```

--------------------------------

### Example: tigris buckets get my-bucket

Source: https://www.tigrisdata.com/docs/cli/buckets/get/

Example command to get details for a bucket named 'my-bucket'.

```bash
tigris buckets get my-bucket
```

--------------------------------

### Install and run TAG with native binary

Source: https://www.tigrisdata.com/docs/acceleration-gateway/quickstart/

Downloads and installs the latest TAG release, sets Tigris credentials as environment variables, and starts TAG with a default config. The install script auto-detects OS and architecture, places the binary in /usr/local/bin, and installs a default config at /etc/tag/config.yaml. To pin a specific release, use https://tag-releases.t3.storage.dev/v1.17.7/install.sh.

```bash
# Download and install TAG (latest release)
curl -fsSL https://tag-releases.t3.storage.dev/latest/install.sh | bash

# Set your Tigris credentials
export AWS_ACCESS_KEY_ID=<your-access-key>
export AWS_SECRET_ACCESS_KEY=<your-secret-key>

# Start TAG
tag --config /etc/tag/config.yaml
```

--------------------------------

### Tigris CLI getting started commands

Source: https://www.tigrisdata.com/docs/changelog/

Basic commands to log in, list buckets, copy files, and recursively copy directories using the t3:// URL scheme.

```bash
# Log in to your Tigris account
tigris login

# List your buckets
tigris ls

# Copy files to and from Tigris
tigris cp ./local-file.txt t3://my-bucket/file.txt
tigris cp t3://my-bucket/file.txt ./local-file.txt

# Recursively copy a directory
tigris cp -r ./local-dir/ t3://my-bucket/my-path/
```

--------------------------------

### Example: Enable write-through mode

Source: https://www.tigrisdata.com/docs/cli/buckets/set-migration/

Enables write-through mode, so writes go to both the source and Tigris. Uses the same flags as the basic setup plus `--write-through`.

```bash
# Enable write-through mode
tigris buckets set-migration my-bucket \
  --bucket source-bucket \
  --endpoint https://s3.amazonaws.com \
  --region us-east-1 \
  --access-key AKIA... \
  --secret-key wJal... \
  --write-through
```

--------------------------------

### Examples: tigris mk bucket and folder creation

Source: https://www.tigrisdata.com/docs/cli/mk/

Multiple examples demonstrating bucket creation with various flags, folder creation, using the t3:// prefix, and creating forks with optional snapshot.

```bash
# Create a bucket
tigris mk my-bucket

# Create a public bucket in a specific region
tigris mk my-bucket --access public --locations iad

# Create a bucket that allows per-object ACLs
tigris mk my-bucket --allow-object-acl

# Create a public bucket with directory listing enabled
tigris mk my-bucket --public --enable-directory-listing

# Create a folder in a bucket
tigris mk my-bucket/images/

# Using t3:// prefix
tigris mk t3://my-bucket

# Create a fork (copy-on-write clone) of an existing bucket
tigris mk my-fork --fork-of my-bucket

# Fork from a specific snapshot of the source bucket
tigris mk my-fork --fork-of my-bucket --source-snapshot 1765889000501544464
```

--------------------------------

### Install Tigris SDK and use get/put

Source: https://www.tigrisdata.com/docs/

Install the TypeScript SDK with npm and use the get and put functions to retrieve and store objects. The example shows importing from '@tigrisdata/storage' and calling get('my-file.jpg', 'file') and put('object.txt', 'Hello, World!').

```terminal
$ npm install @tigrisdata/storage
```

```typescript
import { get, put } from '@tigrisdata/storage';

await get('my-file.jpg', 'file');

await put('object.txt', 'Hello, World!');
```

--------------------------------

### Examples: bundling objects with tigris bundle

Source: https://www.tigrisdata.com/docs/cli/bundle/

Four examples demonstrating different ways to specify keys and output: comma-separated keys, keys from a file, gzip compression, and piping keys from stdin.

```bash
# Bundle specific keys into a tar file
tigris bundle my-bucket --keys key1.jpg,key2.jpg --output archive.tar
```

```bash
# Read keys from a file
tigris bundle my-bucket --keys keys.txt --output archive.tar
```

```bash
# Compress with gzip
tigris bundle t3://my-bucket --keys keys.txt --compression gzip -o archive.tar.gz
```

```bash
# Pipe keys from stdin
cat keys.txt | tigris bundle my-bucket > archive.tar
```

--------------------------------

### Configure S3Client for Tigris with AWS JS SDK

Source: https://www.tigrisdata.com/docs/sdks/s3/aws-js-sdk/

Sets up the AWS S3Client to connect to Tigris by specifying the endpoint and disabling path-style addressing. Requires access keys from the Getting Started guide.

```js
import { S3Client } from "@aws-sdk/client-s3";

const S3 = new S3Client({
  region: "auto",
  endpoint: "https://t3.storage.dev",
  s3ForcePathStyle: false,
});
```

--------------------------------

### Examples: tigris buckets create with various options

Source: https://www.tigrisdata.com/docs/cli/buckets/create/

Provides multiple examples of creating buckets with different configurations, including private, public, snapshots, ACLs, directory listing, and forks.

```bash
# Create a private bucket
tigris buckets create my-bucket

# Create a public bucket in a specific region
tigris buckets create my-bucket --access public --locations iad

# Create with snapshots and infrequent access tier
tigris buckets create my-bucket --enable-snapshots --default-tier STANDARD_IA

# Create a bucket that allows per-object ACLs
tigris buckets create my-bucket --allow-object-acl

# Create a public bucket with directory listing enabled
tigris buckets create my-bucket --public --enable-directory-listing

# Create a fork (copy-on-write clone) of an existing bucket
tigris buckets create my-fork --fork-of my-bucket

# Fork from a specific snapshot of the source bucket
tigris buckets create my-fork --fork-of my-bucket --source-snapshot 1765889000501544464
```

--------------------------------

### Check install and log in

Source: https://www.tigrisdata.com/docs/cli/

Verifies the CLI installation and initiates login.

```bash
tigris --version
tigris login
```

--------------------------------

### Example: tigris access-keys get tid_AaBbCcDdEeFf

Source: https://www.tigrisdata.com/docs/cli/access-keys/get/

Example command to get details for a specific access key using its ID.

```bash
tigris access-keys get tid_AaBbCcDdEeFf
```

--------------------------------

### Examples: Create policy from file, inline JSON, and stdin

Source: https://www.tigrisdata.com/docs/cli/iam/policies/create/

Three examples showing how to create a policy using a JSON file, inline JSON, or stdin via `cat`.

```bash
# Create from a JSON file
tigris iam policies create my-policy --document policy.json
```

```bash
# Create with inline JSON
tigris iam policies create my-policy --document '{"Version":"2012-10-17","Statement":[...]}'
```

```bash
# Create from stdin
cat policy.json | tigris iam policies create my-policy
```

--------------------------------

### Examples: tigris buckets lifecycle create

Source: https://www.tigrisdata.com/docs/cli/buckets/lifecycle/create/

Four examples demonstrating different lifecycle rules: transition to STANDARD_IA, transition with prefix, expiration with prefix, and combined transition and expiration.

```bash
# Transition all objects to STANDARD_IA after 30 days
tigris buckets lifecycle create my-bucket --storage-class STANDARD_IA --days 30

# Scope to a prefix: archive logs/ to GLACIER after 90 days
tigris buckets lifecycle create my-bucket --prefix logs/ --storage-class GLACIER --days 90

# Expire objects under tmp/ after 7 days
tigris buckets lifecycle create my-bucket --prefix tmp/ --expire-days 7

# Transition then expire: archive/ → GLACIER at 30d, delete at 365d
tigris buckets lifecycle create my-bucket --prefix archive/ \
  --storage-class GLACIER --days 30 --expire-days 365
```

--------------------------------

### Examples: tigris iam policies get

Source: https://www.tigrisdata.com/docs/cli/iam/policies/get/

Two examples: one for interactive selection (no ARN) and one for getting a specific policy by ARN.

```bash
# Interactive selection
tigris iam policies get

# Get specific policy by ARN
tigris iam policies get arn:aws:iam::org_id:policy/my-policy
```

--------------------------------

### Get a presigned URL for a GET operation

Source: https://www.tigrisdata.com/docs/sdks/tigris/using-sdk/

Example of using getPresignedUrl with operation 'get' to retrieve a presigned URL for an object. Logs the URL on success.

```ts
const result = await getPresignedUrl("object.txt", { operation: "get" });

if (result.error) {
  console.error("Error getting presigned URL:", result.error);
} else {
  console.log("Presigned URL:", result.data.url);
}
```

--------------------------------

### Examples: tigris buckets set

Source: https://www.tigrisdata.com/docs/cli/buckets/set/

Six example commands demonstrating various bucket settings: making a bucket public, setting locations and cache control, setting a custom domain, changing default tier, enabling soft delete with retention days, and disabling soft delete.

```bash
# Make a bucket public
tigris buckets set my-bucket --access public

# Set location restrictions and cache control
tigris buckets set my-bucket --locations iad,fra --cache-control 'max-age=3600'

# Set a custom domain
tigris buckets set my-bucket --custom-domain assets.example.com

# Default new objects to the infrequent-access tier
tigris buckets set my-bucket --default-tier STANDARD_IA

# Keep deleted objects recoverable for a week
tigris buckets set my-bucket --soft-delete enable --retention-days 7

# Turn soft delete off again
tigris buckets set my-bucket --soft-delete disable
```

--------------------------------

### Tigris JavaScript SDK put and get example

Source: https://www.tigrisdata.com/docs/ai-agents/what-is-tigris/

Use the Tigris JavaScript SDK to put and get a string object. The get method returns the data as a string.

```js
// Tigris JavaScript SDK
import { put, get } from "@tigrisdata/storage";

await put("hello.txt", "Hello from Tigris!");
const data = await get("hello.txt", "string");
```

--------------------------------

### Handling a response from get()

Source: https://www.tigrisdata.com/docs/sdks/tigris/using-sdk/

Example of checking the error property before accessing data when using the get method to download an object.

```TypeScript
const objectResult = await get("photo.jpg", "file");
if (objectResult.error) {
  console.error("Error downloading object:", objectResult.error);
} else {
  console.log("Object name:", objectResult.data?.name);
  console.log("Object size:", objectResult.data?.size);
  console.log("Object type:", objectResult.data?.type);
}
```

--------------------------------

### Install Go storage SDK

Source: https://www.tigrisdata.com/docs/objects/bundle/

Install the Go SDK for the Bundle API.

```bash
go get github.com/tigrisdata/storage-go
```

--------------------------------

### Get object metadata example

Source: https://www.tigrisdata.com/docs/sdks/tigris/using-sdk/

Example of using the `head` function to get metadata for 'object.txt'. It logs an error if the operation fails, otherwise logs the metadata object with properties like contentDisposition, contentType, modified, path, size, and url.

```ts
const result = await head("object.txt");

if (result.error) {
  console.error("Error getting object metadata:", result.error);
} else {
  console.log("Object metadata:", result.data);
  // output: {
  //   contentDisposition: "inline",
  //   contentType: "text/plain",
  //   modified: "2023-01-15T08:30:00Z",
  //   path: "object.txt",
  //   size: 12,
  //   url: "https://tigris-example.t3.storage.dev/object.txt",
  // }
}
```

--------------------------------

### Run the AWS Go SDK example

Source: https://www.tigrisdata.com/docs/sdks/s3/aws-go-sdk/

Command to run the example program, replacing 'bucket-name' with the actual bucket name.

```sh
go run main.go bucket-name
```

--------------------------------

### Examples of tigris buckets commands

Source: https://www.tigrisdata.com/docs/cli/buckets/

Provides basic examples of bucket operations: listing, creating, getting, setting access to public, and deleting a bucket.

```bash
tigris buckets list
tigris buckets create my-bucket
tigris buckets get my-bucket
tigris buckets set my-bucket --access public
tigris buckets delete my-bucket
```

--------------------------------

### Examples: Create a team

Source: https://www.tigrisdata.com/docs/cli/iam/teams/create/

Three examples: create a team without options, with a description, and with members.

```bash
# Create a team
tigris iam teams create engineering

# Create a team with a description
tigris iam teams create engineering --description "Engineering team"

# Create a team with members
tigris iam teams create engineering --members a@example.com,b@example.com
```

--------------------------------

### Get an object as a string

Source: https://www.tigrisdata.com/docs/sdks/tigris/using-sdk/

Example of using `get` with format 'string' to download an object as a string. Logs the object data or an error if the operation fails.

```TypeScript
const result = await get("object.txt", "string");

if (result.error) {
  console.error("Error getting object:", result.error);
} else {
  console.log("Object:", result.data);
  // output: "Hello, World!"
}
```

--------------------------------

### Get an object as a file

Source: https://www.tigrisdata.com/docs/sdks/tigris/using-sdk/

Example of using `get` with format 'file' and options for content disposition, content type, and encoding. Logs the object data or an error.

```TypeScript
const result = await get("object.pdf", "file", {
  contentDisposition: "attachment",
  contentType: "application/pdf",
  encoding: "utf-8",
});

if (result.error) {
  console.error("Error getting object:", result.error);
} else {
  console.log("Object:", result.data);
}
```

--------------------------------

### Examples: Uploading files and piped data

Source: https://www.tigrisdata.com/docs/cli/objects/put/

Five examples showing how to upload a file, set access and content type, set cache control, and pipe data from stdin. The last example uses a t3:// path.

```bash
# Upload a file
tigris objects put my-bucket report.pdf ./report.pdf
```

```bash
# Upload with public access and explicit content type
tigris objects put my-bucket logo.png ./logo.png --access public --content-type image/png
```

```bash
# Upload with a cache lifetime
tigris objects put my-bucket logo.png ./logo.png --cache-control 'public, max-age=86400'
```

```bash
# Upload piped data from stdin (omit the file argument)
echo 'hello' | tigris objects put my-bucket hello.txt
```

```bash
# Pipe a command's output straight into an object (t3:// paths work too)
cat report.pdf | tigris objects put t3://my-bucket/report.pdf --content-type application/pdf
```

--------------------------------

### Gemfile for AWS Ruby SDK v3

Source: https://www.tigrisdata.com/docs/sdks/s3/aws-ruby-sdk/

Gemfile specifying dependencies for the AWS Ruby SDK v3 example: nokogiri and aws-sdk-s3. This is the required setup for the examples on this page.

```ruby
# frozen_string_literal: true

source "https://rubygems.org"

gem 'nokogiri', '~> 1.18'
gem 'aws-sdk-s3', '~> 1'
```

--------------------------------

### Install Tigris CLI and create bucket and key

Source: https://www.tigrisdata.com/docs/

Install the Tigris CLI globally with npm, then create a bucket with 't3 mk my-bucket' and create a key with 't3 touch my-bucket/key'. The output confirms successful creation.

```terminal
$ npm install -g @tigrisdata/cli
```

```terminal
$ t3 mk my-bucket

✓ Bucket 'my-bucket' created
```

```terminal
$ t3 touch my-bucket/key

✓ Created 'my-bucket/key'
```

--------------------------------

### Get an object as a stream

Source: https://www.tigrisdata.com/docs/sdks/tigris/using-sdk/

Example of using `get` with format 'stream' and options for content disposition, content type, and encoding. Reads the stream using a reader and logs the result.

```TypeScript
const result = await get("video.mp4", "stream", {
  contentDisposition: "attachment",
  contentType: "video/mp4",
  encoding: "utf-8",
});

if (result.error) {
  console.error("Error getting object:", result.error);
} else {
  const reader = result.data?.getReader();
  // Process stream...
  reader?.read().then((result) => {
    console.log(result);
  });
}
```

--------------------------------

### Examples: List keys for a specific policy and interactive selection

Source: https://www.tigrisdata.com/docs/cli/iam/policies/list-keys/

Two examples: one lists keys for a specific policy ARN, the other triggers interactive policy selection when no ARN is provided.

```bash
# List keys for a specific policy
tigris iam policies list-keys arn:aws:iam::org_id:policy/my-policy
```

```bash
# Interactive policy selection
tigris iam policies list-keys
```

--------------------------------

### Examples: tigris access-keys list

Source: https://www.tigrisdata.com/docs/cli/access-keys/list/

Examples of using the command with different options: default, JSON format, and a limit of 50 items.

```bash
tigris access-keys list
tigris access-keys list --format json
tigris access-keys list --limit 50
```

--------------------------------

### Get bucket information example

Source: https://www.tigrisdata.com/docs/sdks/tigris/using-sdk/

Example of calling getBucketInfo with a bucket name and handling the result. On success, logs the data object with properties like isSnapshotEnabled and hasForks; on error, logs the error.

```TypeScript
const result = await getBucketInfo("my-bucket");

if (result.error) {
  console.error("Error getting bucket info:", result.error);
} else {
  console.log("Bucket info:", result.data);
  // output: {
  //   isSnapshotEnabled: true,
  //   hasForks: false,
  //   sourceBucketName: undefined,
  //   sourceBucketSnapshot: undefined
  // }
}
```

--------------------------------

### Example: tigris update

Source: https://www.tigrisdata.com/docs/cli/update/

Example of running the update command.

```bash
tigris update
```

--------------------------------

### Examples: tigris login credentials

Source: https://www.tigrisdata.com/docs/cli/login/credentials/

Two examples: one that prompts for credentials, and one that provides them directly using the `--access-key` and `--access-secret` flags.

```bash
# Login with credentials (will prompt for values)
tigris login credentials
```

```bash
# Login with credentials directly
tigris login credentials --access-key tid_AaBb --access-secret tsec_XxYy
```

--------------------------------

### Launch interactive shell with npx

Source: https://www.tigrisdata.com/docs/ai/agent-shell/

Start an interactive Agent Shell session directly using npx, no installation required.

```bash
npx @tigrisdata/agent-shell
```

--------------------------------

### Example prompts for object actions

Source: https://www.tigrisdata.com/docs/quickstarts/mcp/

Natural-language commands to list, upload, create folders, create objects, generate shareable links, and delete objects in a bucket.

```text
List objects in my-bucket
Upload /path/to/file.txt to my-bucket
Create a folder test in my-bucket
Create test.txt with content "Hello World" in my-bucket
Generate a shareable link for test.txt
Delete myfile.txt from my-bucket
```

--------------------------------

### Get a presigned URL for a PUT operation

Source: https://www.tigrisdata.com/docs/sdks/tigris/using-sdk/

Example of using getPresignedUrl with operation 'put' to retrieve a presigned URL for uploading an object.

```ts
const result = await getPresignedUrl("object.txt", { operation: "put" });
```

--------------------------------

### Examples: tigris access-keys create

Source: https://www.tigrisdata.com/docs/cli/access-keys/create/

Provides multiple examples of creating access keys with different options: default scope, bucket scoping with roles, admin access, saving to .env, exporting to shell, and using AWS SDK variable names.

```bash
# A key with the default allowed operations
tigris access-keys create my-ci-key

# Scoped to one bucket
tigris access-keys create my-ci-key --bucket my-app-bucket --role Editor

# Different roles on different buckets, paired in order
tigris access-keys create my-ci-key --bucket bucket-a,bucket-b --role Editor,ReadOnly

# Admin access to every bucket
tigris access-keys create my-admin-key --admin

# Save the credentials to .env instead of printing the secret
tigris access-keys create my-app-key --bucket my-app-bucket --role Editor --env

# Put the credentials straight into the current shell
eval "$(tigris access-keys create my-app-key --export)"

# Name the variables for the AWS SDK
tigris access-keys create my-app-key --for aws --env
```

--------------------------------

### Examples: Unlink key from policy and interactive selection

Source: https://www.tigrisdata.com/docs/cli/iam/policies/unlink-key/

Two examples: one that unlinks a specific key from a specific policy using the `--id` flag and `--yes` to skip confirmation, and one that starts interactive selection when no arguments are provided.

```bash
# Unlink a specific key from a specific policy
tigris iam policies unlink-key arn:aws:iam::org_id:policy/my-policy --id tid_AaBb --yes

# Interactive selection
tigris iam policies unlink-key
```

--------------------------------

### Examples: Assign roles, grant admin, revoke roles

Source: https://www.tigrisdata.com/docs/cli/access-keys/assign/

Four examples demonstrating how to assign an editor role to a bucket, assign different roles to multiple buckets, grant admin access, and revoke all roles.

```bash
# Assign editor role to a bucket
tigris access-keys assign tid_AaBb --bucket my-bucket --role Editor

# Assign different roles to multiple buckets
tigris access-keys assign tid_AaBb --bucket a,b --role Editor,ReadOnly

# Grant admin access
tigris access-keys assign tid_AaBb --admin

# Revoke all roles
tigris access-keys assign tid_AaBb --revoke-roles
```
Tokens:
Raw