CLI configuration
Written by
Updated at December 16, 2024
You can set the parameters in the profile to quickly switch the command execution context. Use global flags for a single run of a command with a specific parameter value.
Warning
Note that some parameters cannot be used simultaneously. The value of one of the parameters is reset to zero after the other is set.
Global flag | Profile parameter | Description |
---|---|---|
--debug |
— | Output the debug log when executing the command. |
--debug-grpc |
— | Output the gRPC debug log when executing the command. This is a very detailed log that is useful for debugging connection issues. |
--cloud-id |
cloud-id |
ID of the cloud to use when executing the command. It is only used in the yc resource-manager folder list command or together with the folder-name parameter. In all other cases, this parameter is ignored. |
--folder-id |
folder-id |
ID of the folder to use when executing the command. When this profile parameter is set, the folder-name parameter is reset to zero. |
--folder-name |
folder-name |
Name of the folder to use when executing the command. When this profile parameter is set, the folder-id parameter is reset to zero. |
--format |
format |
Format for the output: text (default), yaml , json , json-rest . |
-h , --help |
— | Output the command help. |
--no-user-output |
— | Exclude the output intended for the user from the stderr error output stream. |
--profile |
— | The name of the profile whose parameters will be used when executing the command. |
— | service-account-key |
The authorized key of a service account in Yandex Cloud. It is set from the file where the key is stored. When this profile parameter is set, the token parameter is reset to zero. |
--token |
token |
The OAuth token that is used for authentication in Yandex Cloud. When this profile parameter is set, the service-account-key parameter is reset to zero. |