Yandex.Cloud
  • Services
  • Why Yandex.Cloud
  • Solutions
  • Pricing
  • Documentation
  • Contact us
Get started
Command line interface
  • Getting started with the CLI
  • Step-by-step instructions
    • All instructions
    • CLI installation
    • Authentication
      • Authenticating as a user
      • Authenticating as a service account
      • Authenticating as a federated user
    • Profile management
      • Creating a profile
      • Managing profile parameters
      • Getting profile information
      • Activating a profile
      • Deleting a profile
  • Concepts
    • Running commands
    • CLI configuration
    • Synchronous and asynchronous command execution modes
  • CLI releases
  • Troubleshooting
  • CLI reference
    • Overview
    • YC CLI management
      • yc operation
      • yc config
      • yc components
    • Service management
      • yc iam
      • yc resource-manager
      • yc compute
      • yc vpc
      • yc managed-clickhouse
      • yc managed-mongodb
      • yc managed-postgresql
  1. Concepts
  2. CLI configuration

CLI configuration

    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.
    --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 (by 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 Authorization 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 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.
    Language / Region
    Careers
    Privacy policy
    Terms of use
    Brandbook
    © 2021 Yandex.Cloud LLC