Commands

Croud follows the standard CLI syntax:

croud [COMMAND] [OPTIONS]

🔐 Example: Login

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).

📋 View Available Commands

To see a list of all available commands:

croud --help

📘 Get Help for a Specific Command

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

croud login --help

This will show you available options, flags, and usage examples for that specific command.

📦 Available Commands

Here’s a list of top-level commands you can run with Croud:

• clusters – Manage CrateDB Cloud clusters

• import-jobs / 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. See:

  croud config profiles current

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