README
VTEX CLI Plugin Settings
Extend the vtex
toolbelt!
Developing
- Clone
vtex/toolbelt
and follow the steps on the Contributing section. - Clone/Create a plugin with this template.
- Change the template name under this project's
package.json
. - Run
yarn link
on this project. - Now run
vtex link @vtex/cli-plugin-settings
(or the new name) on thevtex/toolbelt
project. - Run
yarn watch
on thevtex/toolbelt
- Test the command on a VTEX IO app with
vtex-test hello
For more information, read Ocliff Docs.
Usage
$ npm install -g @vtex/cli-plugin-settings
$ vtex COMMAND
running command...
$ vtex (-v|--version|version)
@vtex/cli-plugin-settings/0.1.1 linux-x64 node-v12.21.0
$ vtex --help [COMMAND]
USAGE
$ vtex COMMAND
...
Commands
vtex settings:get APPNAME [FIELD]
vtex settings:set APPNAME FIELD VALUE
vtex settings:unset APPNAME FIELD
vtex settings:get APPNAME [FIELD]
Prints the settings of an app.
USAGE
$ vtex settings:get APPNAME [FIELD]
ARGUMENTS
APPNAME Name of the app to check the available settings.
FIELD Name of the setting.
OPTIONS
-h, --help show CLI help
-v, --verbose Show debug level logs
--trace Ensure all requests to VTEX IO are traced
ALIASES
$ vtex settings
EXAMPLE
vtex settings get vtex.service-example
See code: build/commands/settings/get.ts
vtex settings:set APPNAME FIELD VALUE
Sets value to an app setting.
USAGE
$ vtex settings:set APPNAME FIELD VALUE
ARGUMENTS
APPNAME Name of the app.
FIELD Name of the setting.
VALUE Value of the setting.
OPTIONS
-h, --help show CLI help
-v, --verbose Show debug level logs
--trace Ensure all requests to VTEX IO are traced
EXAMPLES
vtex settings set vtex.service-example fieldName fieldValue
vtex settings set vtex.store enableCriticalCSS true
See code: build/commands/settings/set.ts
vtex settings:unset APPNAME FIELD
Disables the specified app setting.
USAGE
$ vtex settings:unset APPNAME FIELD
ARGUMENTS
APPNAME Name of the app.
FIELD Name of the setting.
OPTIONS
-h, --help show CLI help
-v, --verbose Show debug level logs
--trace Ensure all requests to VTEX IO are traced
EXAMPLE
vtex settings unset vtex.service-example fieldName
See code: build/commands/settings/unset.ts