README.md

Octivi Bash Boilerplate (OBB)

If you are writing a script that is more than 100 lines long, or that uses non-straightforward control flow logic, you should rewrite it in a more structured language now. -- Google Shell Style Guide

Features

• Supports Unofficial Bash "Strict Mode
• Supports DEBUG environment variable
• Supports NO_COLOR environment variable for disabling colors
• Supports FORCE_COLOR environment variable
• Supports ANSI colors
• Logging helpers
• Built-in documentation (generate -h output based on comments)
• Supports POSIX getopts

Other resources

Style Guides

• Google Shell Style Guide
• Bash FAQ
• Pure Bash Bible
• Unix shell script tactics - best practices style guide
• Shell Scripts Matter
• Bash tips: Colors and formatting

Boilerplates

• BASH3 Boilerplate (b3bp)
• https://github.com/xwmx/bash-boilerplate
• https://github.com/oxyc/bash-boilerplate
• https://github.com/ralish/bash-script-template
• https://github.com/andrei-pavel/bash-boilerplate

Tools

• ShellCheck
• Shellharden

License

All content is licensed under the terms of The MIT License.