Beard.sh

Grow scripts like a beard!
Minimalist framework for building extensible bash scripts.
Features:

• ⚡   Hands free code generation
• 💾   Easy install

---

Table of contents

• features
• quickstart
• builtin commands
• usage
• log

---

features

hands free code generation

No more touching files and creating scripts from scratch!
Hands free code generation takes care of boilerplate code and command routing so you don't have to!

easy install

Get started in seconds!
Want to install without using quickstart? No problem! Use the install script!

---

quickstart

Run the script below and give it a name. That's it.

{
  (
    clone-sh2() {
      test "${SH2}" || {
        clone sh2 
        echo -e "\ndeclare -x SH2='$( realpath sh2 )'" >> ~/.bashrc 
      }
    }
    clone() {
      git clone https://github.com/temptemp3/${1}.git ${2:-${1}}
    }
    prompt-name() {
      read -p "What's Me's name? (niceboy) " name
    }
    get-name() {
      while [ ! "${name}" ]
      do
       prompt-name
      done
    }
    exit-on-duplicate-name() {
      test ! -d "${name}" || { 
        echo "Someone else has Me's name!" 
        exit 
      }
    }
    install() {
      echo -e "\n${name}() { bash '$( realpath clipboy.sh )' \${@} ; }" >> ~/.bashrc
    }
    fix-permissions() {
      find . -type f -name \*.sh | xargs chmod u+x
    }
    if-darwin() {
      test ! "$( uname )" = "Darwin" || {
        which dos2unix &>/dev/null || {
          brew install dos2unix
        }
        {
          find ${name} -type f -name \*.sh \
          | xargs dos2unix
        }
      }
    }
    name=""
    get-name
    exit-on-duplicate-name
    echo "Me's name is ${name}!"
    clone beard.sh ${name}
    (
      cd ${name}
      clone-sh2
      fix-permissions
      install
    )
    if-darwin
    source ~/.bashrc
  )
}

---

builtin commands

• make command
  • make functions and new commands
• store command
  • get, set, and list stored values
• install command
  • add function to bashrc calling calling script at install path
• shellcheck command, requires shellcheck
  • analyze source code

---

usage

Suppose that we complete the quickstart and end up calling our beard bob. Here follows all the things bob can do out of the box.

commands

It can run any command you have done in the commands directory.

bob command

Specifying only the command as above forces the default sub command to run.

Each command comes with a base set of sub commands, one of which is help.

bob command:help

By default, help lists the sub commands available.

The command command is not included out of the box.

install

cd /path/to/install
bash clipboy.sh install

make

It comes with a builtin command to make things including lemonade if you are unfamiliar with its sub commands.

functions

bob make:function test

By default, in the case of test, bob will create a directory called test.sh with script called test.sh. However, you may want bob to just create a bash script without a directory. In that case, we would added the --single long option as follows.

bob make:function test --single

Optional, you may also provide the --dated option to instruct it to prefix the filename with a date string, that is, yymmdd.

bob make:function test --single --dated

make:function helpful when you need to need a point to start writing a new bash script. However, it may be used to extend it, there is a sub command more helpful call command.

commands

bob make:command new-command

scripts

bob make:script new-script

subcommands

bob make:subcommand new-command-extension

Running make:subcommand after make:script using the same argument links the subcommand to the script. This way we are able to isolate code that actually does something in the scripts directory.

store

bob store:subcommand args

get

bob store:get tel

bob store:get tel
123456789

set

bob store:set tel 123456789

bob store:set tel 123456789

list

bob store:list

$ bob store:list 
tel: 123456789
fax: 123456780

shellcheck

all

bob shellcheck:all

$ bob shellcheck:all
checking for shellcheck ... 
ok
checking scripts/200305-store-get.sh ...
ok
checking scripts/200305-store-list.sh ...
ok
...

---

todo

1. add shellcheck command scripts
2. add branch selection to quickstart

---

log

• 2021/05/12 - add shellcheck command
• 2020/12/24 - add darwin install help to quickstart
• 2020/10/24 - add source to quickstart
• 2020/10/18 - add fix-permissions to quickstart
• 2020/10/13 - rename: clipboy.sh -> beard.sh
• 2020/10/12 - add install command
• 2020/07/15 - add make subcommands from neoboy, fix quickstart (sh3 -> sh2)
• 2020/03/06 - expand on make command
• 2020/03/01 - fixed missing create-stub2 for quickstart make commands
• 2020/02/27 - add initial features and usage
• 2020/02/26 - update quickstart to loop on missing name and include sh2
• 2020/02/24 - update quickstart (asks name), add make command
• 2020/01/24 - add support for drop-in commands
• 2018/11/09 - add support for dialog and act customization outside of core
• 2018/11/08 - initial

---