Getting Started

Installation

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

To install it, run:

sh$ pip install croud

To update to the latest version, run:

sh$ pip install -U croud

Running Croud

After installation, verify it by checking the version:

sh$ croud --version

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

sh$ croud login --idp cognito

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

Note

You might want to use an other --idp (Identity Provider) argument to specify a different authentication method, like azuread, github or google.

Tip

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 command-line options:

Argument

Description

-h

--help

Show the help message, then exits

-v

--version

Display the current version, then exits

Croud commands support additional subcommands and flags. Use –help after any command for more information:

sh$ 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:

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

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