Skip to main content

Tigris CLI

Tigris CLI provides a simple and powerful command line interface to manage your Tigris resources such as buckets, objects, access keys, and IAM policies.

Try it in your browser​

tigrisruns in this tab
Starting shell…

Install​

curl -fsSL https://get.t3.storage.dev/install.sh | sh

Check the install, then log in:

tigris --version
tigris login

To update the CLI later, run tigris update.

Other install methods: Homebrew and npm

With Homebrew:

brew install tigrisdata/tap/tigris

To update, run brew upgrade tigrisdata/tap/tigris.

With npm:

npm install -g @tigrisdata/cli

To update, run tigris update.

Authentication​

Tigris CLI supports multiple login methods. It allows you to log in via your browser (human-friendly) or with an access key and secret (machine-friendly). tigris login allows you to select between the two methods.

OAuth authentication​

The quickest way to get started is to log in via your browser (OAuth authentication):

tigris login oauth

This opens a browser window for OAuth authentication. Once complete, your session is active and you can start using all commands. If you have multiple organizations, the first organization in the list will be selected automatically. You can select a different organization by running tigris organizations list.

Sessions created with tigris login oauth will automatically expire in about an hour. If you need to end such a session sooner, run tigris logout.

Access key and secret authentication​

To log in with an access key and secret:

tigris login credentials --access-key <your-key> --access-secret <your-secret>

Sessions created with tigris login credentials are also temporary and are cleared when you run tigris logout.

Saving credentials permanently​

To save credentials permanently so they persist across sessions:

tigris configure --access-key <your-key> --access-secret <your-secret>

This writes your credentials to ~/.tigris/config.json. After configuring, all commands use these credentials without needing to log in each time.

AWS Profiles and Environment Variables​

You can use AWS profiles or environment variables with Tigris CLI.

AWS_PROFILE=<your-profile> tigris <command> [flags]

or

export AWS_ACCESS_KEY_ID=<your-key>
export AWS_SECRET_ACCESS_KEY=<your-secret>
export AWS_REGION=auto

tigris <command> [flags]

Verifying authentication status​

You can verify your authentication status at any time:

tigris whoami

Testing credentials​

To test that your credentials have access to a specific bucket:

tigris credentials test
tigris credentials test --bucket my-bucket