Introducing BASH3 Boilerplate

2 minute read

This project now has its own homepage at

When hacking up BASH scripts, I often find there are some higher level things like logging, configuration, command-line argument parsing that:

  • I need every time
  • Take quite some effort to get right
  • Keep you from your actual work

Here's an attempt to bundle those things in a generalized way so that they are reusable as-is in most of my (and hopefully your, if not ping me) programs.


Delete-key-friendly. I propose using as a base and removing the parts you don't need, rather than introducing a ton of packages, includes, compilers, etc.

Aiming for portability, I'm targeting Bash 3 (OSX still ships with 3 for instance). If you're going to ask people to install Bash 4 first, you might as well pick a more advanced language as a dependency.

We're automatically testing bash3boilerplate and it's proven to work on:

  • Linux GNU bash, version 4.2.25(1)-release (x86_64-pc-linux-gnu)
  • OSX GNU bash, version 3.2.51(1)-release (x86_64-apple-darwin13)


  • Structure
  • Safe defaults (break on error, pipefail, etc)
  • Configuration by environment variables
  • Configuration by command-line arguments (definitions parsed from help info, so no duplication needed)
  • Magic variables like __file and __dir
  • Logging that supports colors and is compatible with Syslog Severity levels


There are 3 ways you can install (parts of) b3bp:

  1. Just get the main template: wget
  2. Clone the entire project: git clone
  3. As of v1.0.3, b3bp can be installed as a package.json dependency via: npm install --save bash3boilerplate

Although 3 introduces a node.js dependency, this does allow for easy version pinning and distribution in environments that already have this prerequisite. But nothing prevents you from just using curl and keep your project or build system low on external dependencies.

Best practices

As of v1.0.3, b3bp adds some nice re-usable libraries in ./src. Later on we'll be using snippets inside this directory to build custom packages. In order to make the snippets in ./src more useful, we recommend these guidelines.

Library exports

It's nice to have a bash package that can be used in the terminal and also be invoked as a command line function. To achieve this the exporting of your functionality should follow this pattern:

if [ "${BASH_SOURCE[0]}" != ${0} ]; then
  export -f my_script
  my_script "${@}"
  exit $?

This allows a user to source your script or invoke as a script.

# Running as a script
$ ./ some args --blah
# Sourcing the script
$ source
$ my_script some more args --blah

(taken from the bpkg project)


  • In functions, use local before every variable declaration
  • This project settles on two spaces for tabs


Leave a Comment Right Here