rdmc
| Crates.io | rdmc |
| lib.rs | rdmc |
| version | 0.1.2 |
| created_at | 2024-02-08 11:02:37.166263+00 |
| updated_at | 2024-02-08 14:38:28.431733+00 |
| description | Run commands from you readme as if its a Makefile |
| homepage | |
| repository | https://github.com/kloki/rdmc |
| max_upload_size | |
| id | 1131985 |
| size | 12,940 |
Koen Klinkers (kloki)
documentation
README
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.