@zeroheight/adoption-cli

@zeroheight/adoption-cli

CLI for measuring component usage to view in your zeroheight account.

For full walk through on how to use this CLI tool, head over to our help centre article.

Release notes

Install

npm i @zeroheight/adoption-cli

Usage

Authentication

Interactive mode

When running a command, you will be prompted to authenticate. This will save the Client ID and Access Token to your local machine.

Alternatively, you can authenticate by running the following command:

zh-adoption auth

Non-interactive mode

When running a command with the --interactive false flag, you will need to provide the Client ID and Access Token as environment variables.

export ZEROHEIGHT_CLIENT_ID="your-client-id"
export ZEROHEIGHT_ACCESS_TOKEN="your-access-token"

Component usage analysis

Help center article

In the React repository in which you wish to get usage metrics around how components from your design system packages are being used, run the following command:

zh-adoption analyze

Options

-e / --extensions

Provide a glob pattern to search for files with a specific extension.

zh-adoption analyze -e "**/*.{js,jsx,ts,tsx}"

-i / --ignore

Provide a glob pattern to ignore files, directories or file extensions when searching for components.

zh-adoption analyze -i "**/*.{test,spec}.*"

-r / --repo-name

Provide a name for the current repository. This must be passed when -in / --interactive is set to false.

zh-adoption analyze -r "My Repo"

-in / --interactive

Pass in false to disable the interactive mode e.g. when running in a CI environment.

zh-adoption analyze --interactive false -r "My Repo"

Monitor repo

Help center article

This will analyze your code repository to help you understand what packages are being used and at what version.

In the repository in which you wish to monitor, run the following command:

zh-adoption monitor-repo

Options

-d / --dir

Provide a path to the specific folder to find package.json and lock file. This option can be passed through multiple times. If not included all folders with package.json and lockfile will be uploaded to zeroheight.

zh-adoption monitor-repo -d ./webApp

Track package

Help center article

This will give zeroheight the name and current version of your design system package so you can compare it to the version being used by your other code repositories.

In the repository containing your design system package, run the following command:

zh-adoption track-package

Options

-in / --interactive

Pass in false to disable the interactive mode e.g. when running in a CI environment.

zh-adoption track-package --interactive false

More info on the commands can be seen by running

zh-adoption --help