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

1.0.0

No more digging through READMEs.

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

Try the demo ->

You've just cloned a repo, fired up an editor, and you're scrolling a 400-line README looking for the "Install" section.

Or you're back in a project after a month and can't remember if it's npm run dev, npm start or npm run serve.

Run hdi, pick a command, hit enter, done.

Install

brew install grega/tap/hdi

mkdir -p ~/.local/bin && curl -fsSL https://github.com/grega/hdi/releases/latest/download/hdi \
      -o ~/.local/bin/hdi && chmod +x ~/.local/bin/hdi

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.

Read the blog post →

Usage

Command	Description
`hdi`	Interactive picker - shows all sections (default)
`hdi install`	Just install/setup commands (aliases: `setup`, `i`)
`hdi run`	Just run/start commands (aliases: `start`, `r`)
`hdi test`	Just test commands (alias: `t`)
`hdi deploy`	Just deploy/release commands and platform detection (alias: `d`)
`hdi all`	All sections (aliases: `a`)
`hdi contrib`	Commands from contributor/development docs (alias: `c`)
`hdi needs`	Check if required tools are installed (alias: `n`)

Full documentation on GitHub →