Code Monkey home page Code Monkey logo

cli-plugin-config's Introduction

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.

oclif npm

Usage

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

Commands

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

cli-plugin-config's People

Contributors

carolinamenezes avatar verasthiago avatar williamads avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Forkers

ghas-results

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.