@tigrisdata/cli

Command line interface for Tigris object storage.

Installation

npm install -g @tigrisdata/cli

Usage

tigris <command> [flags]

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

Core Commands

• tigris ls [path] - List buckets or objects in a bucket or path
• tigris mk <path> - Create a bucket or a folder in a bucket
• tigris touch <path> - Create an empty object in a bucket
• tigris cp <src> <dest> - Copy a folder or an object
• tigris mv <src> <dest> - Move a folder or an object
• tigris rm <path> - Remove a bucket or a folder in a bucket or an object in a bucket or path

Authentication

• tigris login - Start a session. Use OAuth (default) or temporary credentials that override your saved config
• tigris logout - End your session. Clears login state but keeps credentials from 'configure'
• tigris whoami - Show information about the current user
• tigris configure - Save credentials permanently. After running this, all commands work automatically

Resources

• tigris organizations - Manage organizations
• tigris access-keys - Manage access keys
• tigris credentials - Manage and test credentials
• tigris buckets - Manage buckets
• tigris forks - Manage forks
• tigris snapshots - Manage snapshots
• tigris objects - Manage objects

Core Commands

ls | list

List buckets or objects in a bucket or path

tigris ls [path]

Examples:

tigris ls my-bucket
tigris ls my-bucket/my-path

mk | create

Create a bucket or a folder in a bucket

tigris mk <path>

Examples:

tigris mk my-bucket
tigris mk my-bucket/my-path

touch

Create an empty object in a bucket

tigris touch <path>

Examples:

tigris touch my-bucket/my-file.txt

cp | copy

Copy a folder or an object

tigris cp <src> <dest>

Examples:

tigris cp bucket/file.txt bucket/copy.txt
tigris cp bucket/folder/ other-bucket/folder/

mv | move

Move a folder or an object

tigris mv <src> <dest> [flags]

| Flag | Description | |------|-------------| | -f, --force | Skip confirmation prompt |

Examples:

tigris mv bucket/file.txt bucket/copy.txt
tigris mv bucket/folder/ other-bucket/folder/

rm | remove

Remove a bucket or a folder in a bucket or an object in a bucket or path

tigris rm <path> [flags]

| Flag | Description | |------|-------------| | -f, --force | Skip confirmation prompt |

Examples:

tigris rm my-bucket
tigris rm my-bucket/my-path
tigris rm my-bucket/my-path/*

Authentication

login | l

Start a session. Use OAuth (default) or temporary credentials that override your saved config

| Command | Description | |---------|-------------| | login select | Choose how to login - OAuth (browser) or credentials (access key) | | login oauth (o) | Login via browser (OAuth2 device flow). Best for interactive use | | login credentials (c) | Login with access key + secret. Creates a temporary session (cleared on logout) |

login select

tigris login select

login oauth

tigris login oauth

login credentials

tigris login credentials [flags]

| Flag | Description | |------|-------------| | -key, --access-key | Your access key ID (will prompt if not provided) | | -secret, --access-secret | Your secret access key (will prompt if not provided) |

logout

End your session. Clears login state but keeps credentials from 'configure'

tigris logout

whoami | w

Show information about the current user

tigris whoami

configure | c

Save credentials permanently. After running this, all commands work automatically

tigris configure [flags]

| Flag | Description | |------|-------------| | -key, --access-key | Your Tigris access key ID | | -secret, --access-secret | Your Tigris secret access key | | -e, --endpoint | Tigris API endpoint (default: https://t3.storage.dev) |

Resources

organizations | orgs

Manage organizations

| Command | Description | |---------|-------------| | organizations list (l) | List organizations | | organizations create (c) | Create organization | | organizations select (s) | Select the organization to use |

organizations list

tigris organizations list [flags]

| Flag | Description | |------|-------------| | -f, --format | Format (default: select) | | -i, --select | Interactive selection mode |

organizations create

tigris organizations create <name>

organizations select

tigris organizations select <name>

access-keys | keys

Manage access keys

| Command | Description | |---------|-------------| | access-keys list (l) | List all access keys | | access-keys create (c) | Create a new access key | | access-keys delete (d) | Delete an access key | | access-keys get (g) | Get details of an access key | | access-keys assign (a) | Assign bucket roles to an access key |

access-keys list

tigris access-keys list

access-keys create

tigris access-keys create <name>

access-keys delete

tigris access-keys delete <id>

access-keys get

tigris access-keys get <id>

access-keys assign

tigris access-keys assign <id> [flags]

| Flag | Description | |------|-------------| | -b, --bucket | Bucket name (can specify multiple) | | -r, --role | Role to assign (can specify multiple to pair with buckets) | | --admin | Grant admin access to all buckets in the organization | | --revoke-roles | Revoke all bucket roles from the access key |

credentials | creds

Manage and test credentials

| Command | Description | |---------|-------------| | credentials test (t) | Test if credentials have access to Tigris (optionally to a specific bucket) |

credentials test

tigris credentials test [flags]

| Flag | Description | |------|-------------| | -b, --bucket | Bucket name to test access against (optional) |

Buckets

Buckets are containers for objects. You can also create forks and snapshots of buckets.

buckets | b

Manage buckets

| Command | Description | |---------|-------------| | buckets list (l) | List buckets | | buckets create (c) | Create bucket | | buckets get (g) | Get bucket details | | buckets delete (d) | Delete bucket | | buckets set (s) | Update bucket settings |

buckets list

tigris buckets list [flags]

| Flag | Description | |------|-------------| | -f, --format | Format (default: table) |

buckets create

tigris buckets create [name] [flags]

| Flag | Description | |------|-------------| | -a, --access | Access level (default: private) | | -s, --enable-snapshots | Enable snapshots for the bucket (default: false) | | -t, --default-tier | Choose the default tier for the bucket (default: STANDARD) | | -c, --consistency | Choose the consistency level for the bucket (default: default) | | -r, --region | Region (default: global) |

buckets get

tigris buckets get <name>

buckets delete

tigris buckets delete <name>

buckets set

tigris buckets set <name> [flags]

| Flag | Description | |------|-------------| | --access | Bucket access level | | --region | Allowed regions (can specify multiple) | | --allow-object-acl | Enable object-level ACL | | --disable-directory-listing | Disable directory listing | | --cache-control | Default cache-control header value | | --custom-domain | Custom domain for the bucket | | --enable-delete-protection | Enable delete protection |

forks | f

Manage forks

| Command | Description | |---------|-------------| | forks list (l) | List forks of a bucket | | forks create (c) | Create a fork of a bucket |

forks list

tigris forks list <name> [flags]

| Flag | Description | |------|-------------| | -f, --format | Output format (default: table) |

forks create

tigris forks create <name> <fork-name> [flags]

| Flag | Description | |------|-------------| | -s, --snapshot | Create fork from a specific snapshot |

snapshots | s

Manage snapshots

| Command | Description | |---------|-------------| | snapshots list (l) | List snapshots of a bucket | | snapshots take (t) | Take a snapshot of a bucket |

snapshots list

tigris snapshots list <name> [flags]

| Flag | Description | |------|-------------| | -f, --format | Output format (default: table) |

snapshots take

tigris snapshots take <name> [snapshot-name]

objects | o

Manage objects

| Command | Description | |---------|-------------| | objects list (l) | List objects in a bucket | | objects get (g) | Get an object | | objects put (p) | Upload an object | | objects delete (d) | Delete an object |

objects list

tigris objects list <bucket> [flags]

| Flag | Description | |------|-------------| | -p, --prefix | Filter objects by prefix | | -f, --format | Output format (default: table) |

objects get

tigris objects get <bucket> <key> [flags]

| Flag | Description | |------|-------------| | -o, --output | Output file path (if not specified, prints to stdout) | | -m, --mode | Response mode (auto-detected from extension if not specified) |

objects put

tigris objects put <bucket> <key> <file> [flags]

| Flag | Description | |------|-------------| | -a, --access | Access level (default: private) | | -t, --content-type | Content type | | -f, --format | Output format (default: table) |

objects delete

tigris objects delete <bucket> <key>

License

MIT