#command #makefile #extract #file #bash

bin+lib rdmc

Run commands from you readme as if its a Makefile

3 releases

0.1.2 Feb 8, 2024
0.1.1 Feb 8, 2024
0.1.0 Feb 8, 2024

#13 in #makefile

MIT/Apache

7KB
133 lines

RDMC - Readme command

Run commands from you readme as if its a Makefile.

Installation

cargo install rdmc

Setup Autocomplete Bash

rdmc --bpaf-complete-style-bash >> ~/.bash_completion

Usage

When you invoke rdmc it will look for a readme file at the root of your current repository. It will extract commands from it.

rdmc <Tab>
rdmc C<Tab>
rdmc Command

Execute

rdmc will only printout the actual command. To run it you can pipe it to a shell.

rdmc <Command> | sh

Readme format

rdmc will extract commands from all code blocks tagged with the bash language. The name of the command is based on its closest heading.

Reference this README file as a properly formatted example.

Dependencies

~2MB
~36K SLoC