@webex/cli-tools

@webex/cli-tools

This package is an internal and private plugin used as a shared module when configuring CLI operations within this project.

• Installation
• Usage
• Contribute
• Maintainers

Installation

Since this package is marked private as a part of its definition, it can only be consumed locally within this project.

This package is meant to be consumed as a dependency.

Installation, local to this project, can be performed by using the following commands:

yarn workspace @{scope}/{package} add @webex/cli-tools

Usage

This package is expected to be consumed as a JavaScript module.

const CLI = require('@webex/cli-tools');

Below is a list of common classes and their usage. See documentation for more information.

Command Class

The Command class is intended to be used as a way to interpret CLI arguments for usage within a workflow.

const { Command } = require('@webex/cli-tools');

const { example } = new Command({
  options: [
    {
      name: 'example',
      description: 'example option description',
      type: 'string',
    },
  ],
}).results;

Contribute

Pull requests welcome. Please see CONTRIBUTING.md for more details.

Maintainers

This package is maintained by Cisco Webex for Developers.