Configuration

You can save frequently used configuration settings in a file. By default, the file is located at ~/.vgs/config on Linux or macOS, or at C:\Users\USERNAME\.vgs\config on Windows.

You may override this location by either setting an environment variable, VGS_CONFIG_FILE, or with a CLI option when invoking a command:

vgs login --config ./config

Format

The CLI expects config files to be compatible with ConfigObj

[login]
idp = ACgymeNXPo5CkQ5cZcmJvPQj

You may be familiar with this format if you've ever used the AWS CLI.

Supported Settings

Section: login

Setting
Description

idp

Custom IdP to log in with.

Configuration Settings and Precedence

Configuration sources for the VGS CLI take precedence in the following order:

  1. Command line options – Explicitly specified options like --idp or --vault.

  2. Environment variables – You can store values in your system's environment variables.

  3. Configuration file – The CLI can read settings from a file.

PreviousDockerNextCommands

Last updated