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, and access keys.

Get started with Tigris CLI by installing it globally using npm:

Installation

npm install -g @tigrisdata/cli

Usage

tigris <command> [flags]

Run tigris help to see all available commands, or tigris <command> help to get details on a specific command.

Authentication

The quickest way to get started is to login via your browser:

tigris login

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, you'll be prompted to select one.

To login with an access key and secret instead:

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

Sessions created with tigris login are temporary — they are cleared when you run tigris logout.

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.

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 work automatically without needing to login each time.

You can verify your authentication status at any time:

tigris whoami

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

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