Get Started
Welcome to Tigris! Tigris stores data as objects within buckets. An object is a file with metadata, and a bucket is a container for objects. To use Tigris, create a bucket with a unique name and upload your data as objects. Each object has a unique key within the bucket. Tigris stores data close to your users and moves it if they change regions. Buckets and objects are private and accessible only via granted access keys.
This guide will have you storing and retrieving objects in minutes — pick the tool that fits your workflow.
Choose Your Tool
- Tigris CLI
- Web Console
- Storage SDK
- MCP
The Tigris CLI lets you manage buckets, objects, and access keys from your terminal.
Install
npm install -g @tigrisdata/cli
Authenticate
tigris login
t3 is shorthand for tigris and can be used interchangeably.
Create a bucket and upload files
# Create a bucket
t3 mk my-bucket
# Upload a file
t3 cp ./photo.jpg my-bucket/photo.jpg
# Upload an entire folder
t3 cp ./images/ my-bucket/images/ -r
List and download objects
# List objects in a bucket
t3 ls my-bucket
# List objects under a prefix
t3 ls my-bucket/images/
# Download an object
t3 cp my-bucket/photo.jpg ./downloaded.jpg
Generate a presigned URL
# Shareable link, expires in 1 hour by default
t3 presign my-bucket/photo.jpg
# Presigned PUT URL with custom expiry (2 hours)
t3 presign my-bucket/report.pdf --method put --expires-in 7200
Remove objects
# Remove a single object
t3 rm my-bucket/old-file.txt -f
# Remove a folder recursively
t3 rm my-bucket/logs/ -rf
Getting Started
- To get started, create an account at storage.new. You'll be up and running in a minute.
- Create a bucket with a unique name.
- Create Access Keys and upload your data using any of the popular S3 tools, libraries, and extensions — Tigris is S3-compatible.
Next Steps
Now that you have a bucket, you can start storing objects in it. An object can be any kind of file: a text file, a photo, a video, or anything else. As Tigris is S3-compatible, you can use standard AWS S3 SDKs and libraries to store and retrieve objects.
Take a look at examples of how to use Tigris with the most popular S3 SDKs and CLIs here.
Or, check out the Dashboard to manage your buckets and objects.
The Tigris SDK gives you type-safe access to object storage from TypeScript and Go.
Install
npm install @tigrisdata/storage
Configure environment variables
Add these to your .env file with the values from your
Tigris dashboard:
TIGRIS_STORAGE_ACCESS_KEY_ID=tid_your_key
TIGRIS_STORAGE_SECRET_ACCESS_KEY=tsec_your_secret
TIGRIS_STORAGE_BUCKET=my-bucket
Upload objects
import { put } from "@tigrisdata/storage";
// Simple upload
await put("hello.txt", "Hello, World!");
// Upload a file
await put("photo.jpg", file);
// Upload a large file with progress tracking
await put("video.mp4", file, {
multipart: true,
onUploadProgress: ({ loaded, total, percentage }) => {
console.log(`Uploaded ${percentage}%`);
},
});
Download objects
import { get } from "@tigrisdata/storage";
// Get as string
const text = await get("hello.txt", "string");
// Get as file
await get("photo.jpg", "file");
// Stream a video
await get("video.mp4", "stream", { contentType: "video/mp4" });
List objects
import { list } from "@tigrisdata/storage";
const objects = await list();
console.log(objects);
The Tigris MCP Server lets AI editors and assistants work with your buckets and objects via the Model Context Protocol.
One-click install
Or add it to Claude Code from your terminal:
claude mcp add --scope user --transport http tigris https://mcp.storage.dev/mcp