https://github.com/gerardnico/bash-lib
A collection of bash libraries and utility scripts
https://github.com/gerardnico/bash-lib
Last synced: 3 months ago
JSON representation
A collection of bash libraries and utility scripts
- Host: GitHub
- URL: https://github.com/gerardnico/bash-lib
- Owner: gerardnico
- Created: 2024-10-03T12:36:56.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-03-06T15:00:41.000Z (3 months ago)
- Last Synced: 2025-03-06T16:21:28.763Z (3 months ago)
- Language: Shell
- Homepage:
- Size: 159 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Bash Libs
## About
A collection of:
* [bash libraries](#where-is-the-library-documentation)
* and [documentation generation script](#where-is-the-script-documentation)
to create bash script.
## Example
### Colorized message
After [installation](#how-to-install), you would use the [bashlib-echo.sh library](docs/lib/bashlib-echo.md) and output an error:
```bash
source bashlib-echo.sh
echo::err "Oups"
```
### Error traps
After [installation](#how-to-install), you would use the [bashlib-error.sh library](docs/lib/bashlib-error.md)
and shows a stack trace if any error with:
```bash
set -Eeuo pipefail
source bashlib-error.sh
error::set_trap
```
## Where is the library documentation?
See each library documentation page for usage.
The `bash-lib` package contains the following libraries:
* [bashlib-array.sh](docs/lib/bashlib-array.md) - Array functions (join, ...)
* [bashlib-bash.sh](docs/lib/bashlib-bash.md) - Bash functions (is interactive, trap, ...)
* [bashlib-cd.sh](docs/lib/bashlib-echo.md) - Cd functions
* [bashlib-command.sh](docs/lib/bashlib-command.md) - Command functions (eval, ...)
* [bashlib-crypto.sh](docs/lib/bashlib-crypto.md) - Cryptographic functions (Key, Cert, ...)
* [bashlib-doc.sh](docs/lib/bashlib-doc.md) - Documentation functions
* [bashlib-echo.sh](docs/lib/bashlib-echo.md) - Echo functions (info, warning, error, tip, ...)
* [bashlib-error.sh](docs/lib/bashlib-error.md) - Error handler functions
* [bashlib-git.sh](docs/lib/bashlib-git.md) - Git functions
* [bashlib-linux.sh](docs/lib/bashlib-linux.md) - Linux functions
* [bashlib-path.sh](docs/lib/bashlib-path.md) - File System Path functions
* [bashlib-script.sh](docs/lib/bashlib-script.md) - Script functions (ie source)
* [bashlib-ssh.sh](docs/lib/bashlib-ssh.md) - Ssh functions
* [bashlib-stack.sh](docs/lib/bashlib-stack.md) - CallStack/Frame functions
* [bashlib-string.sh](docs/lib/bashlib-string.md) - String functions
* [bashlib-template.sh](docs/lib/bashlib-template.md) - Template functions
* [bashlib-vault.sh](docs/lib/bashlib-vault.md) - Retrieve secret from vault (hashicorp or pass)
## How to load a library
```bash
source bashlib-[name].sh
# to load the echo library
source bashlib-echo.sh
```
## Express Cli using these libraries
* [direnv-ext](https://github.com/gerardnico/direnv-x) - Direnv Express - A direnv extension to get secret from vault
* [dock-x](https://github.com/gerardnico/dock-x) - Dock Express - Your docker command driven by environment variables
* [git-x](https://github.com/gerardnico/git-x) - Git Express - Command plugin/extensions (back up Github, execute a command against multiple repositories, ...)
* [kube-x](https://github.com/gerardnico/kube-x) - Kube Express - a framework to provision and manage a kubernetes cluster
* [ssh-x](https://github.com/gerardnico/ssh-x) - SSH Express - a framework to manage SSH connection
## How to install
### With Homebrew
```bash
brew install --HEAD gerardnico/tap/bashlib
```
### With Git
```bash
git clone https://github.com/gerardnico/bash-lib
# Add the libraries and script directory into your path in your `.bashrc` file
export PATH=$PWD/bash-lib/lib:$PATH
export PATH=$PWD/bash-lib/bin:$PATH
```
## Where is the Script documentation?
This package get also the following scripts:
* [bashlib-docgen](docs/bin/bashlib-docgen.md) - Generate the documentation of bash scripts and libraries
## How to contribute? Dev Documentation
See [dev](dev/docs/dev.md)
## Env
`BASHLIB_LIBRARY_PATH` is the directory of the libraries. It's optional if the library are in a directory
that is in the `PATH` environment variable.