# 🔊 Bol

An [`oh-my-zsh`](https://github.com/robbyrussell/oh-my-zsh) plugin, that prints a random quote when you open a terminal.

![Screenshot](images/preview.png)

## 💽 How to install

1. Clone this repository in `oh-my-zsh` custom plugins directory:

```bash
git clone https://github.com/ikhurramraza/bol ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/bol
```

2. Add the plugin to the list of plugins inside `~/.zshrc`:

```bash

plugins=(bol)
```

3. Start a new terminal session.

## ⚙️ Options

1. You can set `BOL_QUIET_MODE` environment variable to avoid printing a quote when you open a terminal. Say in your VS Code integrated terminal.

## 📖 Usage

This plugin comes with a CLI to perform simple tasks.

If no subcommand is passed, it calls the `print` subcommand.

#### 🆘 Help

Each subcommand comes with its own `help` subcommand. That defines the usage and options with examples.

#### 🖨 Print

Print a random quote.

```bash
Usage: bol print [options]
```

#### ➕ Add a quote

A new quote can be added using the `bol add` command.

```bash
Usage: bol add <name> <quote> [options]

Examples:
bol add bad-code "Code is like humor. If you have to explain it, it’s bad."
bol add bad-code "Code is like humor. If you have to explain it, it’s bad." --author "Cory House"
```