bog/README.md

bog

Bash Output Generator

Usage

Anotate your script with formatting helpers by using pipe construct

Example

echo "Script title" | title
echo "Author: You"  | subtitle

Tasks are represented introduced by the section helper. The flow is :

1. Print section header
2. Use output helpers to display the output you want generated
3. End your call with result

echo "Task number One" | section
ls -l		       | output
echo "Warning"	       | output::warning
ls /non_existent_file  |& output