https://github.com/noah2610/util.sh
Common bash utility functions
https://github.com/noah2610/util.sh
bash util
Last synced: 2 months ago
JSON representation
Common bash utility functions
- Host: GitHub
- URL: https://github.com/noah2610/util.sh
- Owner: Noah2610
- License: mit
- Created: 2019-07-08T20:24:23.000Z (almost 7 years ago)
- Default Branch: v2
- Last Pushed: 2025-02-05T02:27:13.000Z (over 1 year ago)
- Last Synced: 2025-04-06T15:51:05.798Z (about 1 year ago)
- Topics: bash, util
- Language: Shell
- Homepage:
- Size: 62.5 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# `util.sh`
Bash utility functions. Primarily for my personal use.
## Installation
### Manually
The easiest way to use my `util.sh` script is to simply download the [`util.sh`][util.sh] script directly
and `source` it yourself from within your bash script.
### Using `download-util.sh`
If you want to make things slightly more ~complicated~ _fun_ for yourself,
you can also download the provided [`download-util.sh`][download-util.sh] script
and run that from within your script to download the newest version of `util.sh`.
`download-util.sh` attempts to download `util.sh` using `curl`.
It will never overwrite an existing file.
### Using the bootstrap
To quickly copy/paste the often-similar boilerplate code for using `util.sh`,
I have provided the [`bootstrap.sh`][bootstrap.sh] file.
The file is quite self-explanatory, once you look inside.
It provides some boilerplate code, which downloads `util.sh` (using `download-util.sh`),
unless the `util.sh` file already exists, and `source`s the file.
## Documentation
Documentation for available utility functions is available at [`DOCS.md`](./DOCS.md).
[util.sh]: ./util.sh
[download-util.sh]: ./download-util.sh
[bootstrap.sh]: ./bootstrap.sh