@zeroheight/adoption-cli
v0.4.4
Published
CLI for measuring component usage
Downloads
256
Readme
@zeroheight/adoption-cli
CLI for measuring component usage to view in your zeroheight account.
See release notes here
Install
npm i @zeroheight/adoption-cli
Usage
Component usage analysis
In the repository in which you wish to analyze the component usage, 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"
To send adoption data to your zeroheight account you will need to authenticate using a Client ID and Access Token.
Authentication
Interactive mode
When running the analyze
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 the analyze
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"
More info on the commands can be seen by running
zh-adoption --help