Getting started

Install the library

Simply install the @tmkn/packageanalyzer package.

npm install @tmkn/packageanalyzer

# or

yarn add @tmkn/packageanalyzer

Using the CLI

After the install, the packageanalyzer is available via pkga:

npx pkga

# or

yarn pkga

Running you first command

Now you can run the analyze command to easily introspect packages:

npx pkga analyze --package react

# or

yarn pkga analyze --package react

See CLI Intro for more options about the functionality of the CLI.

Using the API

See Using Custom Reports to get started with using the packageanalyzer programmatically.