## Setup

1. Clone this repository.
2. Add `minion/bin` to your `PATH`.

> `/usr/bin/bash` must be available, but does not need to be your default shell.

Create a folder `~/Journal`.

## Basic Usage

Run `mn TOPIC DESCRIPTION` to start a new note file.
A new file called `~/Jounal/2026/06-TOPIC-DESCRIPTION.md` will be opened in `vim`.

Run `ml TOPIC` to list all notes with `TOPIC` in the file name, under `~/Journal/2026`.

Run `mo TOPIC` to open all `.md` files in `~/Journal/2026` that contain `TOPIC` in the file name. 

Use `mla` and `moa` variants to search all year folders in `~/Journal/`. (`~/Journal/2025`, `~/Journal/2026`, etc.)

Run `mh` to see `help` further available commands.

## Recommended Usage

- For ongoing daily work, I keep one file each month with `mn daily` and `mo 06-daily`.
- For a random meeting, use `mn meeting topic with some key terms` to create `~/Journal/2026/06-meeting-topic-with-some-key-terms.md`
- When too many old files match my favorite search term, I move old ones into `~/Journal/archive/2026`, where `mla` and `moa` can still find them, in a pinch.

## Customizing

`minion` will respect your `$EDITOR` setting. If `$EDITOR` is not set, `minion` will open files with `nano`.

> `minion` will *not* judge you if $EDITOR is not set to `vi`.

You could modify the scripts to change the journal home folder, which defaults to `$HOME/Journal`.