# CHR

CHR(Command History Report): A command history report tool base on your shell history file.

[![Hex.pm version](https://img.shields.io/hexpm/v/chr.svg)](https://hex.pm/packages/chr)
[![Twitter: ThaddeusJiang](https://img.shields.io/twitter/follow/ThaddeusJiang.svg?style=social)](https://twitter.com/ThaddeusJiang)

> Inspired by the Fig report, this tool aims to provide a similar experience for those not using Fig.

![FigWrapped image](./docs/assets/fig-wrapped.png)

## Features

> [!IMPORTANT]
> CHR does not collect any data. It only processes the data in your shell history file.

- 🏆Top Commands
- 📂Top Directories
- 💦Busiest Day
- 📅Weekly Activity
- 🕙Daily Activity

## Install

requires Elixir to be installed

```sh
brew install elixir
mix escript.install hex chr
```

## Usage

```
chr
```

![A Command History Report generated by CHR](./docs/assets/v0.2.2.png)

## Author

👤 **Thaddeus Jiang**

- Website: https://thaddeusjiang.com/
- Twitter: [@ThaddeusJiang](https://twitter.com/ThaddeusJiang)
- Github: [@ThaddeusJiang](https://github.com/ThaddeusJiang)

## Acknowledgement

This has been possible due to the previous work of numerous people. In particular:

- @borkdude - Author of babashka, thanks for helping me remove the manual data preparation requirement