Bash ToolKit

A configurable bash menu. This was developed for Ubuntu-flavored Linux ditros, but theoretically should work in any standard bash shell.

Setup
AWS Session Tools
Menu Configuration
Bash Profile Additions
Tests!

Setup

Create an alias in your bash profile. You could simply put this in your ~/.bashrc file, or wherever you organize your bash aliases.

alias btk='. /path/to/bash-toolkit/btk.sh'

When you open a terminal, simply execute the btk alias, and follow the menu options as you wish. You may need to check/setup your aws config/credentials.

Pro Tip

For cleaner, expandable, and maintainable bash profile config, use bash profile additions described below.

AWS Session Tools

This toolkit includes some aws session tools, allowing you to easily check aws environment variables and establish a session with an mfa code.

Dependencies

jq - Command-ling JSON Parser
~/.aws/credentials config

jq

For Ubuntu-based distributions, install jq with:

sudo apt install jq

For other platforms, download from jq's website.

Credentials

The mfa tool uses non-default aws credentials to spawn a live session, storing session credentials in the default profile. For example, your credentials file should look like this:

[example1]
aws_access_key_id = <key id for example1>
aws_secret_access_key = <key for example1>
mfa_serial = <mfa arn for example1>

[example2]
aws_access_key_id = <key id for example2>
aws_secret_access_key = <key for example2>
mfa_serial = <mfa arn for example2>

You should not have a [default] credential setup initially, as the mfa tool will override it with the live session. You do not need 2 credential sets such as example1 and example2 - this is just a sample for if you had more than 1. After running the mfa tool, this credentials file will have [default] properties, but keep in mind those properties will change next time you initialize with an mfa token. Ideally, the session creds should only be stored in the shell environment variables, but not all libraries and tools used with aws properly access the environment variables.

Menu Configuration

To edit the menu options and functions, see the config/menus.sh file. Say you wanted to add a sub-menu; you can add code like the following to create a menu:

createMenu "mySubMenu" "My Sub Menu"
addMenuItem "mySubMenu" "Quit" l8r
addMenuItem "mySubMenu" "My fancy tool" fancyToolFunc
addMenuItem "mySubMenu" "My Easter Egg" easterEggFunc

Now add mySubMenu to the mainMenu so you have a way to load your new menu:

addMenuItem "mainMenu" "Go to My Sub Menu" loadMenu "mySubMenu"

Don't forget to define your new functions for mySubMenu:

function fancyToolFunc() {
    echo "TODO: do something fawncy here."
    pause
}

function easterEggFunc() {
    echo "  _  _   __  _   _    __  "
    echo " //_// //_  //  //  // // "
    echo "// // //_  //_ //_ //_//  "
    echo "~~~~~~~~~~~~~~~~~~~~~~~   "
    pause
}

Bash Profile Additions

It's common for a dev workspace to need numerous bash profile settings; Environment variables, aliases, functions, etc. Pile all of these into one file, and things can get messy real quick; Difficult to manage. Instead, you can create a folder in your home directory to store shell files with your organized config.

Create a folder in your home directory:
```
mkdir ~/bash_profile
```

Add a for loop at the bottom of your ~/.bashrc file to source *rc.sh files:

for filename in ~/bash_profile/*rc.sh; do
    source $filename
done

Place file(s) named with the pattern of *rc.sh in ~/bash_profile; For example, to create some dev workflow aliases, create a file in ~/bash_profile called dev-rc.sh, and put your desired aliases in that file:

REPOS_DIR="/path/to/repos"

# GO PLACES
alias glab="cd $REPOS_DIR/gitlab"
alias ghub="cd $REPOS_DIR/github"
alias pg="cd $REPOS_DIR/playground"
alias mvp="cd $REPOS_DIR/github/most-valuable-project"

# BUILD
alias b='gradle build --parallel --continue'
alias br='gradle build --refresh-dependencies --continue'
alias cb='gradle clean build --parallel --continue'
alias cbr='gradle clean build --refresh-dependencies --continue'

# RUN
alias runme="gradle cargoRunLocal -i -Ddebug=true"

# GIT
alias dw='git diff -w'

# BASH TOOLKIT
alias btk='. /path/to/bash-toolkit/btk.sh'

Note

You can be as granular or all-encompassing as you like. Have lots of aliases? You can break them up in topic-based *rc.sh files.

Tests!

Some-what of an Easter Egg - this project has a small collection of "bash unit tests". Bash is powerful, but commands and functions have ways of surprising you with the more you mesh together - the nature of building things. Write tests to check code sanity, rule in/out problem code, or to re-enforce functionality - especially in collaborative coding. Run the tests:

tests/runTests.sh

tveal / bash-toolkit