sh/README.md
2025-03-22 20:12:33 -05:00

50 lines
1.7 KiB
Markdown

# SH
## Description
Bash scripts and files related to them.
## Table of Contents
- [Description](#description)
- [Features](#features)
- [Usage](#usage)
- [Credits / Resources](#credits--resources)
- [Cheatsheets](#cheatsheets)
- [License](#license)
## Features / TODOS
+ Easy automation
+ Template with flags and params.
+ Bare template with simple logic.
+ Cheat Sheets
[ ] TODO Better Examples.
[ ] TODO Better Usage Guide.
[ ] Reformat lines 812+ of cheatsheet into .MD
## Usage
To make .sh executable just:<br>
`chmod +x filename.sh` and then execute like this `./filename.sh`<br>
For ease of use add the folder (such as /sh) to your $PATH. You can also:<br>
`curl https://myrepos.dev/Randy-Jordan/sh/raw/branch/main/template.sh | /bin/bash` TODO, add gist subpath
## Credits / Resources
[Bash Cheat Sheet](https://devhints.io/bash)<br>
[Minimal Bash Template](https://betterdev.blog/minimal-safe-bash-script-template/)<br>
[Awesome Cheatsheets](https://github.com/LeCoupa/awesome-cheatsheets/)<br>
[Rehan Saeed - Bash Cheat Sheet](https://github.com/RehanSaeed/Bash-Cheat-Sheet/blob/main/README.md)<br>
[Bash-hackers wiki](https://web.archive.org/web/20230406205817/https://wiki.bash-hackers.org/) _(bash-hackers.org)_
[Shell vars](https://web.archive.org/web/20230318164746/https://wiki.bash-hackers.org/syntax/shellvars) _(bash-hackers.org)_
[Learn bash in y minutes](https://learnxinyminutes.com/docs/bash/) _(learnxinyminutes.com)_
[Bash Guide](http://mywiki.wooledge.org/BashGuide) _(mywiki.wooledge.org)_
[ShellCheck](https://www.shellcheck.net/) _(shellcheck.net)_
## Cheatsheets
Sourced from above and compiled in to one cheatsheet.md in the repo.
## License
This project is licensed under MIT - see the [LICENSE](LICENSE) file for details.