Getting started

🚀Installation

The Croud CLI is available as a Python package on PyPI.

To install it, run:

pip install croud

To upgrade to the latest version:

pip install -U croud

---

▶️Getting Started

After installation, verify it by checking the version:

croud --version

You must authenticate before using most commands. To log in:

croud login

This will open a browser window to authenticate with your CrateDB Cloud account.

For headless environments (e.g., CI/CD pipelines), you can authenticate by setting the following environment variables instead of running croud login:

• CRATEDB_CLOUD_API_KEY

• CRATEDB_CLOUD_API_SECRET

Once logged in, you can begin using Croud to manage your projects, clusters, organizations, users, and more.

⚙️ Command-Line Options

Croud supports the following global options:

Option	Description
-h, --help	Show the help message and exit
-v, --version	Display the current version and exit

Some Croud commands support additional subcommands and flags—use --help after any command for more information:

croud clusters --help

⌨️ Shell Auto-Completion

Croud offers tab-completion support for the following shells:

• bash

• zsh

• tcsh

To print the appropriate completion script, run:

croud --print-completion {bash,zsh,tcsh}

Refer to your shell’s documentation for instructions on how to install the completion script.