Updated on 2023-03-13 GMT+08:00

Setting Custom Parameters in a Profile

KooCLI allows you to set custom parameters in a profile. This helps you manage parameters that are frequently used in commands, have long values, or have values to be encrypted. Run the following command to enter the interactive mode and add or modify custom parameters in a profile:

hcloud configure set [--cli-profile=${profileName}] --cli-custom=true

hcloud configure set --cli-profile=test --cli-custom=true
  1. Enter the custom parameter name: projectId
  2. Encrypt the custom parameter for storage? (y/N): n
  3. Enter the parameter value: 06810000000000000000000000f89d2e
  Custom parameter saved. To stop setting more custom parameters, press `Ctrl+C`.
  1. Enter the custom parameter name: password
  2. Encrypt the custom parameter for storage? (y/N): y
  3. Enter the parameter value: ****
Custom parameter saved. To stop setting more custom parameters, press `Ctrl+C`.

A custom parameter cannot exceed 128 characters. During interactive setting, determine whether to encrypt the custom parameter for storage according to your requirements. To ensure the security of your custom parameters that need to be encrypted for storage, the system anonymizes the parameter values you enter. The entered characters are displayed as asterisks (****) after you press Enter.

To use a custom parameter, replace the original value in the command with custom.${Name of the custom parameter}. For example:

hcloud ECS NovaListServers --cli-profile=test --project_id="custom.projectId"

When you use an encrypted custom parameter, KooCLI anonymizes the parameter value in places where the value may be displayed, for example, in the printed request URL of debugging information or in printed body parameters in dryrun mode.