# @berries/acai-cli

> CLI tool calculate bugs in git repositories based on commit messages.

Latest version **1.3.7** (published 2019-02-04) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @berries/acai-cli
pnpm add @berries/acai-cli
yarn add @berries/acai-cli
bun add @berries/acai-cli
```

Provides the command `acai`.

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.3.7 |
| Published | 2019-02-04 |
| First published | 2018-01-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8 |
| Dependencies | 4 |
| Unpacked size | 26.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 9 |
| Author | Martin Helmut Fieber |
| Maintainers | martinhelmut |
| Keywords | predict, bugs, git, commit, acai, cli, berries |

## Links

- npm: https://www.npmjs.com/package/@berries/acai-cli
- Repository: https://github.com/MartinHelmut/berries
- Homepage: https://pick-your-berries.net
- Issues: https://github.com/MartinHelmut/berries/issues
- npm.io page: https://npm.io/package/@berries/acai-cli

## Dependencies (4)

- [ora](https://npm.io/package/ora.md) 3.0.0
- [yargs](https://npm.io/package/yargs.md) 12.0.5
- [strip-ansi](https://npm.io/package/strip-ansi.md) 5.0.0
- [@berries/acai](https://npm.io/package/@berries/acai.md) 3.1.6

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 1.3.7 (latest) — 2019-02-04
- 1.3.6 — 2018-12-21
- 1.3.5 — 2018-09-09
- 1.3.4 — 2018-08-05
- 1.3.3 — 2018-05-29
- 1.3.2 — 2018-05-13
- 1.3.1 — 2018-03-24
- 1.3.0 — 2018-02-21
- 1.2.0 — 2018-02-17
- 1.1.4 — 2018-02-08
- 1.1.3 — 2018-01-30
- 1.1.2 — 2018-01-30
- 1.1.1 — 2018-01-30
- 1.1.0 — 2018-01-30
- 1.0.4 — 2018-01-21
- … 3 more at https://npm.io/package/@berries/acai-cli/versions

## README

# @berries/acai-cli

<p align="center">
    <img
        src="https://raw.githubusercontent.com/MartinHelmut/berries/master/packages/acai-cli/logo.svg?sanitize=true"
        width="350"
        height="255"
        alt="Berries acai cli logo with three berries and two leafs shown."
    />
</p>

[![npm][npmimg]][npmurl]
[![Build Status][bsurl]][bsimg]
[![Coverage Status][csimg]][csurl]
[![lerna][lnimg]][lnurl]
[![Commitizen friendly][cfimg]][cfurl]
[![code style: prettier][ptimg]][pturl]

**Calculate bug spots in git repositories based on commit messages.**

This is the command line tool that uses the [@berries/acai][acurl] library to calculate a list of files that where bug prone in the recent past by applying a score value to the files. The older a commit for a file gets, the less priority it has. This prevents files that where fixed a long time ago to be forever on top of the list.

**Important note:** The results for the hot spots are only relevant for the project itself and can not be compared from one project to another (except you find a way to do it! 😉).

<p align="center">
    <img
        src="https://cdn.rawgit.com/MartinHelmut/berries/24b7e579/packages/acai-cli/usage-example.svg"
        width="620"
        height="378"
        alt="Animated usage example of the acai cli."
    />
</p>

## Table of contents

-   [Environment](#environment)
-   [Usage](#usage)
    -   [Options](#options)
-   [License](#license)

## Environment

-   Node >= 8
-   NPM >= 5

## Usage

You can install the CLI with:

```shell
$ npm i @berries/acai-cli -g
```

and run the _acai-cli_ inside a git repository (other version control systems will be follow):

```shell
$ acai
```

or use npx and run acai directly:

```shell
$ npx @berries/acai-cli
```

### Options

| Option    | Short | Description                                                                                                       |
| --------- | ----- | ----------------------------------------------------------------------------------------------------------------- |
| --help    | -h    | Show the help text for acai command line tool                                                                     |
| --version |       | Show the installed CLI version                                                                                    |
| --cwd     | -d    | Define a different git repository, e.g.: `$ acai -d "path/to/git/repo"`                                           |
| --format  | -F    | Define the output format. Available options: `human`                                                              |
| --branch  | -b    | Branch to run stats on, default branch is the currently selected                                                  |
| --depth   | -D    | Define how many commits in the past should be considered                                                          |
| --files   | -f    | One or more file patterns to match against. You can use [http://www.globtester.com][glurl] to test your patterns. |

## License

MIT

[npmurl]: https://www.npmjs.com/package/@berries/acai-cli
[npmimg]: https://img.shields.io/npm/v/@berries/acai-cli.svg
[bsurl]: https://travis-ci.org/MartinHelmut/berries.svg?branch=master
[bsimg]: https://travis-ci.org/MartinHelmut/berries
[csimg]: https://coveralls.io/repos/github/MartinHelmut/berries/badge.svg?branch=master
[csurl]: https://coveralls.io/github/MartinHelmut/berries?branch=master
[lnurl]: https://lernajs.io/
[lnimg]: https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg
[cfimg]: https://img.shields.io/badge/commitizen-friendly-brightgreen.svg
[cfurl]: http://commitizen.github.io/cz-cli/
[ptimg]: https://img.shields.io/badge/code_style-prettier-ff69b4.svg
[pturl]: https://github.com/prettier/prettier
[acurl]: https://github.com/MartinHelmut/berries/tree/master/packages/acai
[glurl]: http://www.globtester.com/

---
_Source: https://npm.io/package/@berries/acai-cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
