Runner module of Heart, which starts an analysis by using a CLI
Last updated 2 months ago by bastien.gatellier.fabernovel .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @fabernovel/heart-cli 
SYNC missed versions from official npm registry.

Heart CLI

Heart CLI is the control module of Heart. It allows every other module to work together, and is able to control the Heart API and the analysis modules. All of that by exposing a small CLI.

Note that you must install an analysis module too, to have a minimum viable installation of Heart.

Read more about the purpose, design and general installation of Heart.

Package manager

In the following sections, every examples are using NPM as package manager, but you can use any other you prefer: Yarn, pnpm...


  1. Add the package to your project:
npm install @fabernovel/heart-cli
  1. Add an analysis module



npx heart --help

This command displays the list of commands you can use, regarding your installed modules.

If you install Heart API or each time you install an analysis module, a new command will be available.


We assume that the analysis module Heart Observatory is installed.

If you want to start an analysis, you can use one of the following options:

  • npx heart observatory --inline '{"host": "heart.fabernovel.com"}'


  • npx heart observatory --file observatory.json

    With the following content for the observatory.json file:

      "host": "heart.fabernovel.com"

Current Tags

  • 3.1.1                                ...           latest (2 months ago)

7 Versions

  • 3.1.1                                ...           2 months ago
  • 3.1.0                                ...           4 months ago
  • 3.0.2                                ...           10 months ago
  • 1.2.1                                ...           10 months ago
  • 1.2.0                                ...           a year ago
  • 1.1.0                                ...           a year ago
  • 1.0.0                                ...           a year ago
Today 0
This Week 0
This Month 7
Last Day 0
Last Week 7
Last Month 12
Dependencies (4)
Dev Dependencies (8)
Dependents (0)

Copyright 2014 - 2016 © taobao.org |