Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kevincobain2000/re
Command Line Tool to execute commands in README.md file.
https://github.com/kevincobain2000/re
Last synced: 3 months ago
JSON representation
Command Line Tool to execute commands in README.md file.
- Host: GitHub
- URL: https://github.com/kevincobain2000/re
- Owner: kevincobain2000
- License: mit
- Created: 2023-05-22T11:40:21.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2023-05-24T14:05:12.000Z (over 1 year ago)
- Last Synced: 2024-04-11T16:36:30.619Z (7 months ago)
- Language: Go
- Homepage: https://kevincobain2000-x.medium.com/automating-command-execution-straight-from-readme-md-5880f4a7f8f1
- Size: 41 KB
- Stars: 8
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Stop going back and forth to README.
CLI to execute commands from local or Github.
Read on Medium
**Hassle Free:** Easy install on any arch. No dependencies.
**About:** Hit `re` command, select multiple commands and execute.
**Platforms:** Supports (arm64, arch64, Mac, Mac M1, Ubuntu and Windows).
**Supports:** Any README.md on local or from Github and Github Enterprise URLs.
**Supports:** Multi-line commands. And colorful UI based on previous execution status.
## Install
Using curl
```sh
curl -sLk https://raw.githubusercontent.com/kevincobain2000/re/master/git.io.sh | sh
echo '\nexport PATH="$HOME/.re/bin:$PATH"\n' >> ~/.bashrc
```
or via go
```sh
go install github.com/kevincobain2000/re@latest
```
## Usage
```sh
re
# By default it looks for sh, bash, powershell etc.. code blocks
# filter by language i.e only commands inside ` ` ` sh blocks are parsed
re sh
```
OR from URL
```sh
# automatically picks README.md from main, master or develop branch
re https://github.com/kevincobain2000/re
# or direct link any other MD file, even provide custom tags
re custom_tag https://github.com/kevincobain2000/re/blob/master/EXAMPLE.md
```
## Colors
`re` displays commands upon previous execution status as RED or GREEN.
You can clear the colors by using `re clear` flag or `re clear `.
This will clear the colors for the given URL, when no URL is provided then cleared based on the commands in `README.md` in the current dir.
# Change Log
- v1.0 - Initial release
- v1.1 - Add support for `re github.com/...repo`
- v1.3 - Add support for enterprise and direct tree/blob paths of `README.md`. Multi-line parsing. And Tags.
- v1.4 - Colors, commands history of exit codes.