 _____ _____ _____ 
||h  |||d  |||i  ||
||___|||___|||___||
|/___\|/___\|/___\|

v0.22.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

Homebrew

brew install grega/tap/hdi

Manual

curl -fsSL https://raw.githubusercontent.com/grega/hdi/main/hdi \
  -o ~/.local/bin/hdi && chmod +x ~/.local/bin/hdi

No dependencies, just Bash. Works on macOS and Linux.

Demo

Try out the demo.

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.

No dependencies, just Bash. Works on macOS and Linux.

Usage

$ cd some-project
$ hdi
[hdi] some-project

 ▸ Installation
  ▶ npm install
    cp .env.example .env

 ▸ Run
    npm run dev

  ↑↓ navigate  ⇥ sections  ⏎ execute  c copy  q quit

Full documentation on GitHub →

Read the blog post →