https://github.com/bkahlert/logr

Logr is a logger written for the Bourne Again SHell — Bash, with a certain focus on aesthetics.
https://github.com/bkahlert/logr

bash container docker linux logger logging shell terminal

Last synced: 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/bkahlert/logr
• Owner: bkahlert
• License: mit
• Created: 2021-10-04T04:25:56.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-04-05T01:58:15.000Z (about 2 years ago)
• Last Synced: 2025-02-12T20:32:37.889Z (4 months ago)
• Topics: bash, container, docker, linux, logger, logging, shell, terminal
• Language: Shell
• Homepage:
• Size: 495 KB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Citation: CITATION.cff
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# logr [![Build Status](https://img.shields.io/github/workflow/status/bkahlert/logr/build?label=Build&logo=github&logoColor=fff)](https://github.com/bkahlert/logr/actions/workflows/build.yml) [![Repository Size](https://img.shields.io/github/repo-size/bkahlert/logr?color=01818F&label=Repo%20Size&logo=Git&logoColor=fff)](https://github.com/bkahlert/logr) [![Repository Size](https://img.shields.io/github/license/bkahlert/logr?color=29ABE2&label=License&logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCA1OTAgNTkwIiAgeG1sbnM6dj0iaHR0cHM6Ly92ZWN0YS5pby9uYW5vIj48cGF0aCBkPSJNMzI4LjcgMzk1LjhjNDAuMy0xNSA2MS40LTQzLjggNjEuNC05My40UzM0OC4zIDIwOSAyOTYgMjA4LjljLTU1LjEtLjEtOTYuOCA0My42LTk2LjEgOTMuNXMyNC40IDgzIDYyLjQgOTQuOUwxOTUgNTYzQzEwNC44IDUzOS43IDEzLjIgNDMzLjMgMTMuMiAzMDIuNCAxMy4yIDE0Ny4zIDEzNy44IDIxLjUgMjk0IDIxLjVzMjgyLjggMTI1LjcgMjgyLjggMjgwLjhjMCAxMzMtOTAuOCAyMzcuOS0xODIuOSAyNjEuMWwtNjUuMi0xNjcuNnoiIGZpbGw9IiNmZmYiIHN0cm9rZT0iI2ZmZiIgc3Ryb2tlLXdpZHRoPSIxOS4yMTIiIHN0cm9rZS1saW5lam9pbj0icm91bmQiLz48L3N2Zz4%3D)](https://github.com/bkahlert/logr/blob/master/LICENSE)

## About

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

[![recorded terminal session demonstrating the logr function](docs/logr.svg "logr function")  

***logr** function*](../../raw/master/docs/logr.svg)

[![recorded terminal session demonstrating the prompt4 function](docs/prompt4.svg "prompt4 function")  

***prompt4** function*](../../raw/master/docs/prompt4.svg)

[![recorded terminal session demonstrating the banr utilities](docs/utilities/banr.svg "banr utilities")  

***banr** utilities*](../../raw/master/docs/utilities/banr.svg)

[![recorded terminal session demonstrating the tracr utilities](docs/utilities/tracr.svg "tracr utilities")  

***tracr** utilities*](../../raw/master/docs/utilities/tracr.svg)

[![recorded terminal session demonstrating the misc utilities](docs/utilities/util.svg "misc utilities")  

***misc** utilities*](../../raw/master/docs/utilities/util.svg)

## 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:

```shell

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

```

## Usage

```shell

# 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

```

```shell

# invoke as binary for a feature overview

chmod +x logr.sh

./logr.sh

# help

./logr.sh --help

```

## Testing

```shell

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](https://github.com/bkahlert/bats-wrapper) is a self-contained wrapper to run tests based on the 

Bash testing framework [Bats](https://github.com/bats-core/bats-core).

> 💡 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](https://www.paypal.me/bkahlert) to ensure this journey continues indefinitely!

Thanks again for your support, it is much appreciated! :pray:

## License

MIT. See [LICENSE](LICENSE) for more details.