orca profile¶
Manage orca configuration profiles.
The reference below is generated from the live CLI by mkdocs-click. It
always reflects the version installed.
orca profile¶
Manage configuration profiles (multi-account).
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
Subcommands
- add: Add a new profile interactively.
- color: Manage profile color.
- edit: Edit an existing profile interactively.
- export: Export profiles to external formats.
- from-clouds: [deprecated, use 'profile import clouds' instead]
- from-openrc: [deprecated, use 'profile import openrc' instead]
- import: Import profiles from external sources.
- list: List all profiles.
- region: Manage profile region.
- regions: [deprecated, use 'profile region list' instead]
- remove: Remove a profile.
- rename: Rename a profile.
- set-color: [deprecated, use 'profile color set' instead]
- set-region: [deprecated, use 'profile region set' instead]
- show: Show profile details. Defaults to active profile.
- switch: Switch the active profile.
- to-clouds: [deprecated, use 'profile export clouds' instead]
- to-openrc: [deprecated, use 'profile export openrc' instead]
orca profile add¶
Add a new profile interactively.
Examples: orca profile add production orca profile add staging --copy-from production --color yellow
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--copy-from |
text | Copy settings from an existing profile. | None |
--color |
text | Profile color (e.g. red, green, blue, cyan, magenta, yellow). | None |
--help |
boolean | Show this message and exit. | False |
orca profile color¶
Manage profile color.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
Subcommands
- set: Set a color for a profile. Use 'none' to remove.
orca profile color set¶
Set a color for a profile. Use 'none' to remove.
Available colors: red, green, blue, yellow, magenta, cyan, white, bright_red, bright_green, bright_blue, bright_yellow, bright_magenta, bright_cyan, orange3, purple, pink1
Examples: orca profile color set red orca profile color set blue production orca profile color set none staging
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
orca profile edit¶
Edit an existing profile interactively.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
orca profile export¶
Export profiles to external formats.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
Subcommands
- clouds: Export a profile as a clouds.yaml entry.
- openrc: Export a profile as an OpenRC shell script.
orca profile export clouds¶
Export a profile as a clouds.yaml entry.
Examples: orca profile export clouds # active profile orca profile export clouds production # specific profile orca profile export clouds production -o clouds.yaml
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--output, -o |
text | Write to file instead of stdout. | None |
--cloud-name |
text | Cloud name in clouds.yaml (default: profile name). | None |
--help |
boolean | Show this message and exit. | False |
orca profile export openrc¶
Export a profile as an OpenRC shell script.
Examples: orca profile export openrc # active profile to stdout orca profile export openrc production # specific profile orca profile export openrc production -o prod-openrc.sh source <(orca profile export openrc) # source directly
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--output, -o |
text | Write to file instead of stdout. | None |
--help |
boolean | Show this message and exit. | False |
orca profile from-clouds¶
Import a cloud from clouds.yaml as an orca profile.
Examples: orca profile import clouds mycloud orca profile import clouds mycloud --name production orca profile import clouds mycloud -f /path/to/clouds.yaml
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--name, -n |
text | Profile name (default: cloud name). | None |
--file, -f |
text | Path to clouds.yaml (default: auto-detect). | None |
--help |
boolean | Show this message and exit. | False |
orca profile from-openrc¶
Import an OpenRC file as an orca profile.
Examples: orca profile import openrc admin-openrc.sh orca profile import openrc admin-openrc.sh --name production
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--name, -n |
text | Profile name (default: filename without extension). | None |
--help |
boolean | Show this message and exit. | False |
orca profile import¶
Import profiles from external sources.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
Subcommands
- clouds: Import a cloud from clouds.yaml as an orca profile.
- openrc: Import an OpenRC file as an orca profile.
orca profile import clouds¶
Import a cloud from clouds.yaml as an orca profile.
Examples: orca profile import clouds mycloud orca profile import clouds mycloud --name production orca profile import clouds mycloud -f /path/to/clouds.yaml
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--name, -n |
text | Profile name (default: cloud name). | None |
--file, -f |
text | Path to clouds.yaml (default: auto-detect). | None |
--help |
boolean | Show this message and exit. | False |
orca profile import openrc¶
Import an OpenRC file as an orca profile.
Examples: orca profile import openrc admin-openrc.sh orca profile import openrc admin-openrc.sh --name production
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--name, -n |
text | Profile name (default: filename without extension). | None |
--help |
boolean | Show this message and exit. | False |
orca profile list¶
List all profiles.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
orca profile region¶
Manage profile region.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
Subcommands
- list: List available regions from the Keystone service catalog.
- set: Set the default region for a profile.
orca profile region list¶
List available regions from the Keystone service catalog.
Authenticates with the current profile and inspects the catalog to show which regions are available.
Examples: orca profile region list orca -P infomaniak profile region list
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
orca profile region set¶
Set the default region for a profile.
Use 'none' to clear the region (use the first available).
Examples: orca profile region set dc3-a orca profile region set dc4-a production orca profile region set none # clear region
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
orca profile regions¶
List available regions from the Keystone service catalog.
Authenticates with the current profile and inspects the catalog to show which regions are available.
Examples: orca profile region list orca -P infomaniak profile region list
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
orca profile remove¶
Remove a profile.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--yes, -y |
boolean | Skip confirmation. | False |
--help |
boolean | Show this message and exit. | False |
orca profile rename¶
Rename a profile.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
orca profile set-color¶
Set a color for a profile. Use 'none' to remove.
Available colors: red, green, blue, yellow, magenta, cyan, white, bright_red, bright_green, bright_blue, bright_yellow, bright_magenta, bright_cyan, orange3, purple, pink1
Examples: orca profile color set red orca profile color set blue production orca profile color set none staging
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
orca profile set-region¶
Set the default region for a profile.
Use 'none' to clear the region (use the first available).
Examples: orca profile region set dc3-a orca profile region set dc4-a production orca profile region set none # clear region
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
orca profile show¶
Show profile details. Defaults to active profile.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
orca profile switch¶
Switch the active profile.
Without a NAME argument, shows an interactive numbered menu.
Examples: orca profile switch # interactive menu orca profile switch production orca profile switch staging
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
orca profile to-clouds¶
Export a profile as a clouds.yaml entry.
Examples: orca profile export clouds # active profile orca profile export clouds production # specific profile orca profile export clouds production -o clouds.yaml
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--output, -o |
text | Write to file instead of stdout. | None |
--cloud-name |
text | Cloud name in clouds.yaml (default: profile name). | None |
--help |
boolean | Show this message and exit. | False |
orca profile to-openrc¶
Export a profile as an OpenRC shell script.
Examples: orca profile export openrc # active profile to stdout orca profile export openrc production # specific profile orca profile export openrc production -o prod-openrc.sh source <(orca profile export openrc) # source directly
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--output, -o |
text | Write to file instead of stdout. | None |
--help |
boolean | Show this message and exit. | False |