Description
Heart CLI is a runner module of Heart, which starts an analysis by using a CLI.
Note that you must have installed an analysis module too.
Read more about the purpose, design and general installation of Heart on the dedicated wiki.
Installation
Add the package to your project:
npm install @fabernovel/heart-cli
Usage
Heart CLI allows you to start the analysis of a single URL with a single service at a time.
General
npx heart /<analysisModuleName> <data>
Explanations:
<analysisModuleName>
is the lowercase version of the analyse module name, without the Heart prefix.<data>
is a stringified JSON that contains information about the analysis you want to do. Its content depends of the analysis module you want to use.
Example
If you have the analysis module Heart Observatory installed, the command will be:
npx heart /observatory '{"project_url": "about.gitlab.com"}'