Skip to content

Usage:

Terminal
$ vlt config <command> [flags]

Work with vlt configuration

When no subcommand is provided, displays help information for the config command.

Subcommands

get

Print the named config value(s). When no keys are provided, shows all configuration settings. When a single key is provided with --config=all (default), returns the merged configuration value. Use --config=user or --config=project to get values from specific configuration files only.

Terminal
$ vlt config get [<key> [<key> ...]] [--config=<all | user | project>]

pick

Select and display specific configuration values. Similar to get but optimized for retrieving multiple specific keys.

Terminal
$ vlt config pick [<key> [<key> ...]] [--config=<all | user | project>]

list

Print all configuration settings currently in effect as key=value pairs. Use --config to specify which configuration source to display.

Terminal
$ vlt config list [--config=<all | user | project>]

Aliases: ls

set

Set config values. By default, these are written to the project config file, vlt.json in the root of the project. To set things for all projects, run with --config=user. Note that --config=all defaults to project for write operations.

Terminal
$ vlt config set <key>=<value> [<key>=<value> ...] [--config=<all | user | project>]

delete

Delete the named config fields. If no values remain in the config file, delete the file as well. By default, operates on the vlt.json file in the root of the current project. To delete a config field from the user config file, specify --config=user. Note that --config=all defaults to project for write operations.

Terminal
$ vlt config delete <key> [<key> ...] [--config=<all | user | project>]

Aliases: del, rm, remove, unset

edit

Edit the configuration file. Note that --config=all defaults to project for write operations.

Terminal
$ vlt config edit [--config=<all | user | project>]

location

Print the file path of the configuration file being used.

Terminal
$ vlt config location [--config=<user | project>]

Examples

Get all configuration (merged from user and project):

Terminal
$ vlt config get

Get a specific configuration value:

Terminal
$ vlt config get registry

Get configuration from user config only:

Terminal
$ vlt config get --config=user

Set a configuration value in the project config:

Terminal
$ vlt config set registry=https://my-registry.com

Set a configuration value in the user config:

Terminal
$ vlt config set color=true --config=user

List all configuration as key=value pairs:

Terminal
$ vlt config list

List configuration using alias:

Terminal
$ vlt config ls

Delete a configuration value:

Terminal
$ vlt config delete registry

Delete a configuration value using alias:

Terminal
$ vlt config del registry

Find the location of the project config file:

Terminal
$ vlt config location --config=project