Bashinator: Bash Shell Script Framework

Bashinator is a framework for bash shell scripts.

Features

• Flexible and powerful message handling: print, log (to syslog and/or logfile) and mail messages (configurable based on severity) with a single message function, for example:
  • Log messages from debug..alert, print messages from info..alert, mail messages from warning..alert
  • Log and mail messages with timestamps, print messages without timestamps
  • Log to syslog and logfile at once, overwrite or append to the logfile
  • Colored output (if printed to a terminal supporting colors, redirected output is not colored)
• Exhaustive information (timestamps, message severity, source file, line numbers and function names) in messages to ease debugging
• Function call stack traces
• Simplifies logging of sub-command output (capturing stdout/stderr of external commands to a dedicated temporary logfile)
• Lockfile handling
• ...and more! ;-)

Quickstart

On Gentoo Linux:

On any other Linux:

Documentation

• Examples: see the example/ directory in the release tarballs.
• Rudimentary presentation: bashinator-20090610.pdf
• Wiki: Bashinator Wiki on GitHub

A typical Bashinator-based application file layout looks like this:

A typical Bashinator-based application script structure looks like this (see example.sh):

• define basic bashinator variables
• source bashinator library + config
• source application library + config
• boot bashinator via __boot()
• dispatch the application via __dispatch()
  • runs __init(): initializes application (command line parsing, argument validation etc.). this function must be defined by the user!
  • runs __prepare(): creates sub-command logfile (if configured), checks for and creates lockfile (if configured). this function is defined by bashinator.
  • runs __main(): the main application code. this function must be defined by the user!
  • runs __cleanup(): removes sub-command logfile (if configured), removes lockfile (if configured). this function is defined by bashinator.

Source and Downloads

• Bashinator source on GitHub
• Bashinator releases on GitHub
• Bashinator releases locally (old)

Screenshots

Messages of example.sh printed on terminal:

Messages of example.sh sent via mail:

Projects based on Bashinator

• LVM Snapshot Toolkit
• LVM Snapshot Backup Wrapper

Bashinator on the web

• Bashinator on GitHub
• Bashinator on Ohloh
• Bashinator on Freecode

Other bash/shell frameworks

• Bash Framework by the Harvard Neuroinformatics Research Group
• Bash Application Runtime Framework (bashARF)
• log4sh: advanced logging framework for shell scripts
• shesfw: Shell Script Framework tool
• Bash-Toolbox -- A Bash scripting toolbox
• oobash -- Framework for bash 4
• blp -- bash library project
• Bang.sh: Bash Script Framework
• A curated list of awesome command-line frameworks, toolkits, guides and gizmos. Inspired by awesome-php.
• S{cripting,ystem,tack} Management (SM) Framework (Core) / SMF
• Bash Manager: mini bash framework for creating command line tools
• Bash Infinity is a modern boilerplate / framework / standard library for bash
• Bach is a Bash testing framework
• Rerun is a simple framework that turns loose shell scripts into modular automation.
• Bash Script Framework - Write faster Shell Scripts with a modern look and feel.

There's also a list of bash frameworks/libraries put together by Donnie Berkholz.

Contact/Imprint

This website is operated by Wolfram Schlich, Höhenweg 45A, 53347 Alfter, Germany

• E-Mail: wschlich*AT*gentoo*DOT*org
• Jabber: wschlich@jabber.laber.fasel.org

Business/consulting inquiries: wolfram.schlich.biz

Last modified: 07. October 2020, 16:58:15 by Wolfram Schlich <wschlich*AT*gentoo*DOT*org>