https://github.com/mbekkomo/log.sh

A logging library for POSIX sh and other shells (Bash, Zsh, Dash).
https://github.com/mbekkomo/log.sh

bash dash logger posix-sh zsh

Last synced: over 1 year ago
JSON representation

A logging library for POSIX sh and other shells (Bash, Zsh, Dash).

• Host: GitHub
• URL: https://github.com/mbekkomo/log.sh
• Owner: mbekkomo
• License: mit
• Created: 2023-05-18T10:05:34.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2023-05-19T10:36:09.000Z (about 3 years ago)
• Last Synced: 2025-01-22T01:17:44.787Z (over 1 year ago)
• Topics: bash, dash, logger, posix-sh, zsh
• Language: Shell
• Homepage:
• Size: 62.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# log.sh

A logging library for POSIX sh and other shells (Bash, Zsh, Dash).

![Preview](/assets/preview.png)


Taken inside [Termux](https://termux.dev) app with font JetBrains Mono and [Catppuccin](https://github.com/Catppuccin) Mocha theme and background.

## Installation

Drop [log.sh](/log.sh) into the same directory as your script and source it.

```sh

source ./log.sh # can be /path/to/log.sh if you place it somewhere

```

## Usage

After sourcing, a `log` function is available in your script. `log` function takes first argument as log mode and the rest of the arguments are the messages, if first argument are not an uppercase mode name or not a mode, the log mode will be set to `TRACE` and make the first argument of the function as one of the messages.

  - Available log modes:

    - `TRACE`

    - `DEBUG`

    - `INFO`

    - `WARN`

    - `ERROR`

    - `FATAL`

## Additional options

log.sh provide way to set additional options, by setting variable to a certain value.

### `LOG_NOCOLOR`

Default: `""`

Whether colors are disabled or not. If set to anything besides null string or empty string, disable ansi-coloring when printed to stdout. This is useful if your terminal doesn't support ansi-coloring.

### `LOG_FILE`

Default: `""`

The path of the file where the log should be stored. By default, it is set to null string (no file are written), but if set, log.sh will write logs into the file.

### `LOG_LEVEL`

Default: `"TRACE"`

The minimum level to log. Any log level that is lower than `LOG_LEVEL` is ignored and no text is printed or written. By default the value is set to `"TRACE"`, the lowest log level, as no log messages are ignored.

The level of each log modes, starting from the lowest: `"TRACE"` `"DEBUG"` `"INFO"` `"WARN"` `"ERROR"` `"FATAL"`

## License

log.sh are licensed under MIT license, see [LICENSE](/license) file for more details.