config

The command croud config offers multiple subcommands to manage its configuration.

There is just one profile configured in the default configuration file. You would only need different profiles if you want to authenticate as different users or use different default organizations.

config show

Show the full configuration.

Usage: croud config show [-h]

Example

sh$ croud config show
==> Info: Configuration file /home/me/.config/Crate/croud.yaml
default-format: table
current-profile: cratedb.cloud
profiles:
  cratedb.cloud:
    auth-token: xxxxxxxxxx
    endpoint: https://console.cratedb.cloud
    format: table
    region: _any_

Note

Note, that the values of auth-token are masked.

config profiles current

Print the current profile.

Usage: croud config profiles current [-h]
                                     [--output-fmt {table,wide,json,yaml}]

Optional Arguments

--output-fmt, --format, -o

Possible choices: table, wide, json, yaml

Change the formatting of the output.

Example

sh$ croud config profiles current
+---------------+----------------------------------+----------+
| name          | endpoint                         | format   |
|---------------+----------------------------------+----------|
| cratedb.cloud | https://console.cratedb.cloud    | table    |
+---------------+----------------------------------+----------+

config profiles use

Switch to a different profile.

Usage: croud config profiles use [-h] [--output-fmt {table,wide,json,yaml}]
                                 profile

Required Arguments

profile

The name of the profile that should be used.

Optional Arguments

--output-fmt, --format, -o

Possible choices: table, wide, json, yaml

Change the formatting of the output.

Example

sh$ croud config profiles use some.other
==> Info: Switched to profile 'some.other'.

config profiles add

Add a new profile to your configuration.

Usage: croud config profiles add [-h] --endpoint ENDPOINT [--format FORMAT]
                                 [--region REGION]
                                 profile

Required Arguments

profile

The name of the profile that should be added.

--endpoint

The API endpoint for the profile.

Optional Arguments

--format

The output format for the profile.

--region

The region for the profile.

Example

sh$ croud config profiles add my-profile --endpoint https://console.cratedb.cloud
==> Info: Added profile 'my-profile'.

config profiles remove

Remove a profile from your configuration.

Usage: croud config profiles remove [-h] profile

Required Arguments

profile

The name of the profile that should be removed.

Example

sh$ croud config profiles remove my-profile
==> Info: Removed profile 'my-profile'.