0.24.0

No more searching the README.

"How do I" surfaces install, run, test and deploy steps and commands all in your terminal.

Try the demo ->

Install

brew install grega/tap/hdi

Works on macOS and Linux (probably WSL2 also).

Demo

Animated demo showing hdi in action

How does it work?

hdi parses a given README's Markdown headings looking for keywords like install, setup, prerequisites, run, usage, getting started, etc. It extracts the fenced code blocks from matching sections and presents them as an interactive, executable list.

Usage

CommandDescription
hdiInteractive picker — shows all sections (default)
hdi installJust install/setup commands (aliases: setup, i)
hdi runJust run/start commands (aliases: start, r)
hdi testJust test commands (alias: t)
hdi deployJust deploy/release commands and platform detection (alias: d)
hdi allAll sections (aliases: a)