remutils

readme

Open the nearest README file.

2026 Rémino Rem https://remino.net/


Installation

brew install remino/remino/readme

Or run the script directly from a clone:

git clone git@github.com:remino/remutils.git
cd remutils/readme
./readme

Usage

Run readme to open the README in the current directory. If none exists, it opens the first README found in an immediate child directory. glow is used when available; otherwise, the README opens in less.

Use -l to list all matching README files in that order:

readme -l

Pass a filename to open it directly, or a directory to open its README:

readme README.md
readme timinal

Run readme -h or man readme for the full reference.