logr

About

Logr is a logger written for the Bourne Again SHell — Bash, with a certain focus on aesthetics.

Installation

logr is a Bash library.

In order to use it, it needs to be downloaded and put on your $PATH which is exactly what the following line is doing:

sudo curl -LfsSo /usr/local/bin/logr.sh https://raw.githubusercontent.com/bkahlert/logr/master/logr.sh

Usage

# logr.sh needs to be sourced to be used
source logr.sh

# sample calls
logr info "logr.sh sourced"
logr task "do some work" -- sleep 2

# invoke as binary for a feature overview
chmod +x logr.sh
./logr.sh

# help
./logr.sh --help

Testing

git clone https://github.com/bkahlert/logr.git
cd logr

# Use Bats wrapper to run tests
curl -LfsS https://git.io/batsw | "$SHELL" -s -- test

Bats Wrapper is a self-contained wrapper to run tests based on the Bash testing framework Bats.

💡 To accelerate testing, the Bats Wrapper checks if any test is prefixed with a capital X and if so, only runs those tests.

Contributing

Want to contribute? Awesome! The most basic way to show your support is to star the project, or to raise issues. You can also support this project by making a PayPal donation to ensure this journey continues indefinitely!

Thanks again for your support, it is much appreciated! 🙏

License

MIT. See LICENSE for more details.