Commands

Croud follows the standard CLI syntax:

sh$ croud [COMMAND] [OPTIONS]

Example: Login

sh$ croud login

This command opens a browser window so you can authenticate with CrateDB Cloud. You must log in before using other commands (unless you’re using headless authentication).

List Available Commands

To see a list of all available commands, use:

sh$ croud --help

To view help and usage details for a specific command, append --help to it:

sh$ croud login --help

Warning

Some commands are for internal use by CrateDB and CrateDB Cloud staff only. They are listed here only to clarify their function, since they appear in the full commands list available under --help.

Available commands

• clusters – Manage CrateDB Cloud clusters

• import-jobs and export-jobs – Import and export data jobs

• config – Manage local Croud configuration

• login/logout – Authenticate with CrateDB Cloud

• me – View current user information

• organizations – Manage organizations

• projects – Manage projects

• products – View available CrateDB products

• subscriptions – View and manage active subscriptions

• users – Manage users

• api-keys – Create and manage API keys

• regions – List available deployment regions

• scheduled-jobs – View and manage scheduled jobs

• cloud-configurations – Manage predefined deployment configurations

Region Support

Note

Most commands support the --region flag to specify the region from which resources are fetched or to which resources are deployed.

• If the --region flag is omitted, Croud defaults to the region specified in the current profile’s API endpoint.

sh$ croud config profiles current

• The special region _any_ allows listing resources across all regions, regardless of where they were deployed.