package

@webex/package-tools

This package is an internal and private plugin used as a shared module when performing operations against packages 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:

# Project root installation.
yarn add @webex/package-tools

# Package installation.
yarn workspace @{scope}/{package} add @webex/package-tools

Usage

This package is intended to be consumed as a CLI executable.

webex-package-tools {command} {...options}

To see a list of available commands and their associated options, run the following command against this package:

webex-package-tools --help

This package can also be consumed as a module. Note that this is not an explicitly intended use-case, but may provide more flexibility when performing complicated workflows.

const { increment, list, Package, scripts } = require('@webex/package-tools');

// Execute a command. See API documentation or CLI help for more information.
increment.handle(options);
list.handle(options);
scripts.handle(options);

// Manage a package. See API documentation for more information.
const pack = new Package(options);

Contribute

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

Maintainers

This package is maintained by Cisco Webex for Developers.