Skip to main content

Configuration

ecctl configure writes local configuration for resource commands. It can also read a compatible local aliyun CLI configuration, overlaying ecctl configuration on top when both exist.

Configure a Region

ecctl configure set region cn-hangzhou

Expected shape:

{
"key": "region",
"profile": "default",
"sensitive": false,
"value": "cn-hangzhou"
}

Set the default output mode:

ecctl configure set output json

Read the effective profile:

ecctl configure get

Expected shape:

{
"lang": "",
"mode": "",
"output": "json",
"profile": "default",
"region": "cn-hangzhou"
}

Credentials

Set AccessKey credentials:

ecctl configure set access-key-id <id>
ecctl configure set access-key-secret <secret>

For STS access, also set the security token:

ecctl configure set security-token <token>

Supported Keys

List supported keys:

ecctl configure list

Current keys:

KeyStored asAllowed values
regionregion_idAny syntactically valid Alibaba Cloud region ID
access-key-idaccess_key_idString
access-key-secretaccess_key_secretString, sensitive
security-tokensts_tokenString, sensitive
langlanguageen, zh-CN
outputoutput_formatjson, text

Secrets are masked by default. Use --show-secret only when you deliberately need to inspect a local secret value.

Profiles

Use --profile to write a named profile:

ecctl --profile production configure set output json

Switch the active profile after it exists:

ecctl configure use production

configure use checks both compatible aliyun configuration and ecctl configuration for the profile name, then records the selected profile in the ecctl config file.

Global Overrides

Global flags override configuration for one command:

ecctl --region cn-beijing --output json --lang en schema --list ecs

Common global flags:

FlagPurpose
--profileSelect a configuration profile
--regionSelect the Alibaba Cloud region for the current command
--outputSelect json or text output
--jsonForce JSON output
--langSelect en or zh-CN user-facing text
--no-colorDisable color in human-readable output
--agent-envelopeWrap JSON output in the ecctl Agent envelope

Environment Variables

ecctl recognizes these environment overrides:

VariablePurpose
ECCTL_PROFILE, ALIBABACLOUD_PROFILE, ALIBABA_CLOUD_PROFILE, ALICLOUD_PROFILEDefault profile when --profile is not passed
ECCTL_REGION, ALIBABA_CLOUD_REGION_ID, ALIBABACLOUD_REGION_ID, ALICLOUD_REGION_IDRegion override when --region is not passed
ALIBABA_CLOUD_CONFIG_PATH, ALIBABACLOUD_CONFIG_PATH, ALICLOUD_CONFIG_PATHPath to a compatible aliyun CLI configuration file