VTEX CLI Plugin Config

Extend the vtex toolbelt!

Developing

1. Clone vtex/toolbelt and follow the steps on the Contributing section.
2. Clone/Create a plugin with this template.
3. Change the template name under this project's package.json.
4. Run yarn link on this project.
5. Now run vtex link @vtex/cli-plugin-config (or the new name) on the vtex/toolbelt project.
6. Run yarn watch on the vtex/toolbelt
7. Test the command on a VTEX IO app with vtex-test hello

For more information, read Ocliff Docs.

• VTEX CLI Plugin Config
• Usage
• Commands

Usage

$ npm install -g @vtex/cli-plugin-config
$ vtex COMMAND
running command...
$ vtex (-v|--version|version)
@vtex/cli-plugin-config/0.1.1 linux-x64 node-v12.22.1
$ vtex --help [COMMAND]
USAGE
  $ vtex COMMAND
...

Commands

• vtex config:get CONFIGNAME
• vtex config:reset CONFIGNAME
• vtex config:set CONFIGNAME VALUE

vtex config:get CONFIGNAME

Prints the value of the requested configuration key.

USAGE
  $ vtex config:get CONFIGNAME

ARGUMENTS
  CONFIGNAME  (env|cluster) Configuration to retrieve the value from.

OPTIONS
  -h, --help     show CLI help
  -v, --verbose  Show debug level logs
  --trace        Ensure all requests to VTEX IO are traced

EXAMPLES
  vtex config get env
  vtex config get cluster

See code: build/commands/config/get.ts

vtex config:reset CONFIGNAME

Resets the specified configuration to its default value.

USAGE
  $ vtex config:reset CONFIGNAME

ARGUMENTS
  CONFIGNAME  (env|cluster) Name of the configuration to reset.

OPTIONS
  -h, --help     show CLI help
  -v, --verbose  Show debug level logs
  --trace        Ensure all requests to VTEX IO are traced

EXAMPLES
  vtex config reset env
  vtex config reset cluster

See code: build/commands/config/reset.ts

vtex config:set CONFIGNAME VALUE

Sets the value of a configuration key.

USAGE
  $ vtex config:set CONFIGNAME VALUE

ARGUMENTS
  CONFIGNAME  (env|cluster) Name of the configuration.
  VALUE       New value of the specified configuration.

OPTIONS
  -h, --help     show CLI help
  -v, --verbose  Show debug level logs
  --trace        Ensure all requests to VTEX IO are traced

EXAMPLES
  vtex config set env envValue
  vtex config set cluster clusterValue

See code: build/commands/config/set.ts