https://github.com/nicholaswilde/libbash

🚀A collection of common bash libraries 🤖
https://github.com/nicholaswilde/libbash

bash libraries mkdocs-material

Last synced: about 1 month ago
JSON representation

🚀A collection of common bash libraries 🤖

• Host: GitHub
• URL: https://github.com/nicholaswilde/libbash
• Owner: nicholaswilde
• License: apache-2.0
• Created: 2022-09-12T08:51:47.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2023-03-14T03:03:43.000Z (over 3 years ago)
• Last Synced: 2025-01-22T22:29:40.185Z (over 1 year ago)
• Topics: bash, libraries, mkdocs-material
• Language: Shell
• Homepage: https://nicholaswilde.io/libbash
• Size: 1.1 MB
• Stars: 0
• Watchers: 3
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: docs/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          

# :rocket: libbash :robot:

[![ci](https://img.shields.io/github/workflow/status/nicholaswilde/libbash/ci?label=ci&style=for-the-badge)](https://github.com/nicholaswilde/libbash/actions/workflows/ci.yaml)

[![tests](https://img.shields.io/github/workflow/status/nicholaswilde/libbash/ci?label=tests&style=for-the-badge)](https://github.com/nicholaswilde/libbash/actions/workflows/tests.yaml)

[![task](https://img.shields.io/badge/Task-Enabled-brightgreen?style=for-the-badge&logo=task&logoColor=white)](https://taskfile.dev/#/)

A collection of common bash libraries

---

## :rocket:  TL;DR

### :floppy_disk:  Installation

From within a git repo.

```shell

git submodule add https://github.com/nicholaswilde/libbash

```

From outside a git repo.

```shell

git clone https://github.com/nicholaswilde/libbash.git

```

### :gear:  Usage

```shell

#!/usr/bin/env bash

DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"

# shellcheck source=/dev/null

source "${DIR}/libbash/init"

source "${LIBBASH_DIR}/str"

lb_to_upper_all "foo"

```

### :arrow_up:  Update

From the base dir with `libbash` submodule installed.

```shell

git submodule update --init --recursive --remote

```

---

## :book:  Documentation

Documentation can be found [here][3].

---

## :bulb:  Inspiration

Inspiration for this repository has been taken from [cyberark/bash-lib][1] and [dylanaraps/pure-bash-bible][4].

---

## :balance_scale:  License

[Apache License 2.0](./LICENSE)

---

## :pencil:  Author

This project was started in 2022 by [Nicholas Wilde][2].

[1]: 

[2]: 

[3]: 

[4]: