# 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. ## Setup[​](#setup "Direct link to Setup") * NPM * Homebrew * Native 1Install Install the Tigris CLI with npm: ``` npm install -g @tigrisdata/cli ``` 2Run Get started by logging in: ``` tigris login ``` 3Update Get the latest updates using: ``` tigris update ``` 1Install Install the Tigris CLI with Homebrew: ``` brew install tigrisdata/tap/tigris ``` 2Run Get started by logging in: ``` tigris login ``` 3Update Get the latest updates using: ``` brew upgrade tigrisdata/tap/tigris ``` 1Install Download the standalone binary (no Node.js required): macOS / LinuxWindows ``` curl -fsSL https://github.com/tigrisdata/cli/releases/latest/download/install.sh | sh ``` 2Run Get started by logging in: ``` tigris login ``` 3Update Get the latest updates using: ``` tigris update ``` ## Authentication[​](#authentication "Direct link to Authentication") Tigris CLI supports multiple login methods. It allows you to login 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[​](#oauth-authentication "Direct link to OAuth authentication") The quickest way to get started is to login 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[​](#access-key-and-secret-authentication "Direct link to Access key and secret authentication") To login with an access key and secret: ``` tigris login credentials --access-key --access-secret ``` Sessions created with `tigris login credentials` are also temporary and are cleared when you run `tigris logout`. ### Saving credentials permanently[​](#saving-credentials-permanently "Direct link to Saving credentials permanently") To save credentials permanently so they persist across sessions: ``` tigris configure --access-key --access-secret ``` This writes your credentials to `~/.tigris/config.json`. After configuring, all commands uses these credentials without needing to login each time. ### AWS Profiles and Environment Variables[​](#aws-profiles-and-environment-variables "Direct link to AWS Profiles and Environment Variables") You can use AWS profiles or environment variables with Tigris CLI. ``` AWS_PROFILE= tigris [flags] ``` or ``` export AWS_ACCESS_KEY_ID= export AWS_SECRET_ACCESS_KEY= export AWS_REGION=auto tigris [flags] ``` ### Verifying authentication status[​](#verifying-authentication-status "Direct link to Verifying authentication status") You can verify your authentication status at any time: ``` tigris whoami ``` ### Testing credentials[​](#testing-credentials "Direct link to Testing credentials") To test that your credentials have access to a specific bucket: ``` tigris credentials test tigris credentials test --bucket my-bucket ```