basherk

(Pronounced sort of how bashrc sounds phonetically)

Handy aliases and functions to make life in the terminal easier.

Installing

Standalone

The easiest way to start using basherk is to download and source the file

curl -Lo ~/.basherk https://raw.githubusercontent.com/traveaston/basherk/master/basherk.sh && . ~/.basherk

# Once sourced, you can set it to source automatically from .bashrc
basherk --install

To have root source basherk from the same file, sudo echo -e "\n. $(_realpath ~/.basherk) # source basherk\n" >> /root/.bashrc Security concern, not recommended

Clone

Additionally, you can clone the repo for contributing, custom aliases, etc.

Clone the repo

git clone https://github.com/traveaston/basherk.git

Source and install basherk

. basherk/basherk.sh
basherk --install

Alternate installs:

# Symlink basherk into home folder
ln -s "$(_realpath basherk/basherk.sh)" ~/.basherk
echo -e "\n. ~/.basherk # source basherk\n" >> ~/.bashrc

# Source basherk directly from the repo
echo -e "\n. \"$(_realpath basherk/basherk.sh)\" # source basherk\n" >> ~/.bashrc
# This is the default behaviour of `basherk --install` if ~/.basherk doesn't exist

Updating

If using basherk standalone, basherk --update will download the latest revision from the master branch and re-source itself.

Contributing

• Lint basherk with shellcheck shellcheck -s bash basherk.sh
• 4 space indentation
• Double quotes
  • Aliases use single quotes
  • Regexes use single quotes
  • Rare cases where single quotes make more sense
• Don't quote LHS of comparison (eg. [[ $foo == "$bar" ]]), except:
  • Subshells should be quoted for readability [[ "$(cat bar.log)" == "foo" ]]
  • Variables concatentated with strings should be quoted
• Quote RHS of comparison (eg. [[ $foo == "$(cat bar.log)" ]]), except:
  • Regex or pattern (and vars containing) shouldn't be quoted [[ $os =~ (mac|unix) ]]
  • String with wildcards shouldn't be quoted [[ $dir == *.git* ]]
  • String with wildcards and spaces should be half-quoted [[ $dir == *"git bar"* ]]
  • Integers shouldn't be quoted
• Variables for if switches (eg. [[ -z $foo ]]) shouldn't be quoted, except:
  • Variables concatentated with strings should be quoted
• Variable assignment should be quoted (foo="bar"), except:
  • When assigning subshell output, don't quote foo=$(curl ifconfig.me)
  • When assigning subshell + strings, quote foo="user@$(curl ifconfig.me)"
  • When assigning an integer, don't quote bar=256
  • When assigning a boolean, don't quote bar=false
• Simple regexes can be inline if it is clean but more complex expressions should be passed by variable
  • Also when containing special characters, especially space, should be passed by variable
• Headings
  • Main and subheadings are prepended with 2 lines
  • Main code blocks are surrounded with Start/End headings
  • Main headings are surrounded with 20x#
  • Subheadings are prepended with 10x#
  • Subheadings with no blank lines before next subheading are placed immediately above the code (see Git diff aliases)
  • Subheadings containing comments or blank lines before next subheading contain an additional newline with a single # (see Redefine builtin commands)
  • Aliases, functions, etc, under headings are sorted alphabetically most of the time, but not always.

Authors

• Trav Easton - Initial work & maintenance

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE file for details

Acknowledgments

• Steve Losh https://stevelosh.com/blog/2009/03/candy-colored-terminal
• more credits peppered throughout basherk.sh