Skip to content

browserforce:plugins:validate

Description

Check a config file, or inline JSON, against the schemas of all settings and report every error with its path and the documentation page of the setting. Removed settings are reported with their migration instructions.

Values written with a dollar sign followed by a variable name in braces (the shell style reference to an environment variable, for example API_KEY) are accepted in place of any value: they are environment variable references that "browserforce apply" resolves and checks before logging in. They are listed in the result. Write two dollar signs in front of the opening brace to keep the literal text.

The command exits with code 1 when the config is invalid; with --json, the result still lists the errors.

Parameters

Name Type Description Default Required Options
config option browserforce config as a JSON string
definitionfile
-f
option path to a browserforce config file
flags-dir option Import flag values from a directory.
json boolean Format output as json.

Examples

$ sf browserforce plugins validate -f ./config/currency.json
$ sf browserforce plugins validate --config '{"settings":{"densitySettings":{"density":"Compact"}}}' --json