Data

Tools

Indexes

Applications

Experiments

Open Source Science

logr

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

https://github.com/bkahlert/logr

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (10.9%) to scientific vocabulary

Keywords

bash container docker linux logger logging shell terminal
Last synced: 6 months ago · JSON representation ·

Repository

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

Basic Info
  • Host: GitHub
  • Owner: bkahlert
  • License: mit
  • Language: Shell
  • Default Branch: master
  • Homepage:
  • Size: 495 KB
Statistics
  • Stars: 3
  • Watchers: 2
  • Forks: 0
  • Open Issues: 5
  • Releases: 8
Topics
bash container docker linux logger logging shell terminal
Created over 4 years ago · Last pushed almost 3 years ago
Metadata Files
Readme Changelog Funding License Citation Codeowners

README.md

logr Build Status Repository Size Repository Size

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
**logr* function*

recorded terminal session demonstrating the prompt4 function
**prompt4* function*

recorded terminal session demonstrating the banr utilities
**banr* utilities*

recorded terminal session demonstrating the tracr utilities
**tracr* utilities*

recorded terminal session demonstrating the misc utilities
**misc* utilities*

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 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! :pray:

License

MIT. See LICENSE for more details.

Owner

  • Name: Björn Kahlert
  • Login: bkahlert
  • Kind: user
  • Location: Berlin, Germany

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
  - given-names: "Björn"
    family-names: "Kahlert"
    orcid: "https://orcid.org/0000-0003-1705-4067"
title: "Logr — logger written for the Bourne Again SHell — Bash, with a certain focus on aesthetics"
version: 0.6.2
date-released: 2021-11-22
url: "https://github.com/bkahlert/logr"

GitHub Events

Total
Last Year

Committers

Last synced: about 1 year ago

All Time
  • Total Commits: 96
  • Total Committers: 1
  • Avg Commits per committer: 96.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Björn Kahlert m****l@b****m 96
Committer Domains (Top 20 + Academic)
bkahlert.com: 1

Issues and Pull Requests

Last synced: 11 months ago

All Time
  • Total issues: 1
  • Total pull requests: 11
  • Average time to close issues: N/A
  • Average time to close pull requests: 3 months
  • Total issue authors: 1
  • Total pull request authors: 2
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.36
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 11
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • meinteuch22 (1)
Pull Request Authors
  • dependabot[bot] (7)
  • github-actions[bot] (4)
Top Labels
Issue Labels
Pull Request Labels
dependencies (7) github_actions (7) recordr (4) docs (4) rec (4)

Dependencies

.github/workflows/build.yml actions
  • actions/checkout v2 composite
  • actions/upload-artifact v2 composite
  • bkahlert/bats-wrapper v0.1.4 composite
  • softprops/action-gh-release v1 composite
.github/workflows/docs.yml actions
  • actions/checkout v2 composite
  • actions/upload-artifact v2 composite
  • bkahlert/recordr v0.2.2 composite
  • peter-evans/create-pull-request v3 composite
.github/workflows/test-report.yml actions
  • dorny/test-reporter v1 composite
Dockerfile docker
  • asciinema/asciinema latest build