@kiwicom/orbit-tracking
v1.1.0
Published
Tracking for orbit design system
Downloads
25
Readme
Orbit tracking
Orbit tracking is a simple cli tool, which clones and parses selected repositories with react-scanner. The output is a json file or files with collected data from gitlab and react-scanner.
Installation
# NPM
npm install --save-dev @kiwicom/orbit-tracking
# Yarn
yarn add -D @kiwicom/orbit-tracking
Packages requires gitlab api token, you have to add it to .env
file:
GITLAB_TOKEN=token
Usage
Running the command without arguments will fetch and parse all available repositories
orbit-tracking
You can fetch and parse only specific repositories from the scope with --scope
argument:
orbit-tracking --scope frontend booking
By default the output will be saved to gitlab repo, but you can specify the path with --output
argument:
orbit-tracking --output path/to/folder
react-scanner requires a config file to make it work, orbit-tracking has a default config inside, but if you will need, you can use your own config:
orbit-tracking --config path/to/config
You can run orbit-tracking --help
to get a list of available options and examples
Scope
| repository | | :----------------------------------------------------------- | | booking | | search | | smart-faq | | core | | frontend | | mmb | | account |