Back to Details

tigris-authentication

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Tigris Authentication & Setup

Tigris 身份验证与配置

Install the CLI

安装CLI

bash
npm install -g @tigrisdata/cli
tigris --version
The CLI is also available as 
t3
(alias for 
tigris
).
bash
npm install -g @tigrisdata/cli
tigris --version
CLI也可以使用别名
t3
（即
tigris
的缩写）。

Quick Start

快速开始

bash
tigris login          # authenticate via browser
tigris whoami         # verify identity
tigris ls             # list your buckets
bash
tigris login          # 通过浏览器完成身份验证
tigris whoami         # 验证当前身份
tigris ls             # 列出你的存储桶

Commands

命令

tigris login

tigris login

Start a session via OAuth (default) or temporary credentials. Session state is cleared on logout.
bash
tigris login                        # interactive — choose OAuth or credentials
tigris login oauth                  # browser-based OAuth2 device flow
tigris login credentials            # access key + secret (prompts if not provided)
tigris login credentials --access-key tid_AaBb --access-secret tsec_XxYy
SubcommandAliasDescription
login
(default)
l
Interactive — choose login method
login oauth
login o
Login via browser using OAuth2 device flow
login credentials
login c
Login with an access key and secret (temporary session)
login credentials
flags:
FlagAliasDescription
--access-key
--key
Access key ID (prompts if not provided)
--access-secret
--secret
Secret access key (prompts if not provided)
通过OAuth（默认方式）或临时凭证启动会话。登出时会清除会话状态。
bash
tigris login                        # 交互式操作——选择OAuth或凭证登录方式
tigris login oauth                  # 基于浏览器的OAuth2设备流登录
tigris login credentials            # 使用访问密钥+密钥（未提供时会提示输入）
tigris login credentials --access-key tid_AaBb --access-secret tsec_XxYy
子命令别名描述
login
（默认）
l
交互式操作——选择登录方式
login oauth
login o
通过浏览器使用OAuth2设备流登录
login credentials
login c
使用访问密钥和密钥登录（临时会话）
login credentials
标志：
标志别名描述
--access-key
--key
访问密钥ID（未提供时会提示输入）
--access-secret
--secret
秘密访问密钥（未提供时会提示输入）

tigris configure

tigris configure

Save access-key credentials to 
~/.tigris/config.json
for persistent use across all commands.
bash
tigris configure --access-key tid_AaBb --access-secret tsec_XxYy
tigris configure --endpoint https://custom.endpoint.dev
FlagAliasDescription
--access-key
--key
Your Tigris access key ID
--access-secret
--secret
Your Tigris secret access key
--endpoint
-e
Tigris API endpoint (default: 
https://t3.storage.dev
)
将访问密钥凭证保存到
~/.tigris/config.json
，以便在所有命令中持久使用。
bash
tigris configure --access-key tid_AaBb --access-secret tsec_XxYy
tigris configure --endpoint https://custom.endpoint.dev
标志别名描述
--access-key
--key
你的Tigris访问密钥ID
--access-secret
--secret
你的Tigris秘密访问密钥
--endpoint
-e
Tigris API端点（默认值：
https://t3.storage.dev
）

tigris whoami

tigris whoami

Print the currently authenticated user, organization, and auth method.
bash
tigris whoami
tigris whoami --json
FlagAliasDescription
--format
-f
Output format (
json
, 
table
; default: 
table
)
--json
Output as JSON
打印当前已验证的用户、组织和身份验证方式。
bash
tigris whoami
tigris whoami --json
标志别名描述
--format
-f
输出格式（
json
、
table
；默认值：
table
）
--json
以JSON格式输出

tigris logout

tigris logout

End the current session and clear login state. Credentials saved via 
configure
are kept.
bash
tigris logout
结束当前会话并清除登录状态。通过
configure
保存的凭证会保留。
bash
tigris logout

tigris credentials test

tigris credentials test

Verify that current credentials are valid. Optionally checks access to a specific bucket.
bash
tigris credentials test
tigris credentials test --bucket my-bucket
FlagAliasDescription
--bucket
-b
Bucket name to test access against (optional)
--format
-f
Output format (
json
, 
table
; default: 
table
)
--json
Output as JSON
验证当前凭证是否有效。可选检查对特定存储桶的访问权限。
bash
tigris credentials test
tigris credentials test --bucket my-bucket
标志别名描述
--bucket
-b
要测试访问权限的存储桶名称（可选）
--format
-f
输出格式（
json
、
table
；默认值：
table
）
--json
以JSON格式输出

tigris orgs list
/ 
create
/ 
select

tigris orgs list
/ 
create
/ 
select

List, create, and switch between organizations.
bash
tigris orgs list                    # list orgs + interactively select one
tigris orgs list --json             # list orgs as JSON
tigris orgs create my-org           # create a new organization
tigris orgs select my-org           # set active organization
CommandAliasDescription
orgs list
orgs l
List all organizations and interactively select one
orgs create <name>
orgs c
Create a new organization
orgs select <name>
orgs s
Set the named organization as active
列出、创建和切换组织。
bash
tigris orgs list                    # 列出组织并交互式选择一个
tigris orgs list --json             # 以JSON格式列出组织
tigris orgs create my-org           # 创建一个新组织
tigris orgs select my-org           # 设置活跃组织
命令别名描述
orgs list
orgs l
列出所有组织并交互式选择一个
orgs create <name>
orgs c
创建一个新组织
orgs select <name>
orgs s
将指定组织设置为活跃组织

Environment Variables

环境变量

When credentials are set via environment variables, they take precedence over 
~/.tigris/config.json
and session state. This is common in CI/CD and serverless environments.
当通过环境变量设置凭证时，它们的优先级高于
~/.tigris/config.json
和会话状态。这在CI/CD和无服务器环境中很常见。

Tigris

Tigris

VariableDescription
TIGRIS_STORAGE_ACCESS_KEY_ID
Tigris access key ID (e.g. 
tid_AaBb
)
TIGRIS_STORAGE_SECRET_ACCESS_KEY
Tigris secret access key (e.g. 
tsec_XxYy
)
TIGRIS_STORAGE_ENDPOINT
Tigris endpoint (
https://t3.storage.dev
)
TIGRIS_STORAGE_BUCKET
Default bucket name
变量描述
TIGRIS_STORAGE_ACCESS_KEY_ID
Tigris访问密钥ID（例如：
tid_AaBb
）
TIGRIS_STORAGE_SECRET_ACCESS_KEY
Tigris秘密访问密钥（例如：
tsec_XxYy
）
TIGRIS_STORAGE_ENDPOINT
Tigris端点（
https://t3.storage.dev
）
TIGRIS_STORAGE_BUCKET
默认存储桶名称

Global Flags

全局标志

These flags are available on all 
tigris
commands:
FlagDescription
--json
Output in JSON format (useful for programmatic/agent consumption)
--yes
Skip confirmation prompts (prevents interactive mode)
这些标志适用于所有
tigris
命令：
标志描述
--json
以JSON格式输出（适用于程序化/Agent调用场景）
--yes
跳过确认提示（禁用交互式模式）