_               _     _ _       _     _
| |__   __ _ ___| |__ | (_) __ _| |__ | |_
| '_ \ / _` / __| '_ \| | |/ _` | '_ \| __|
| |_) | (_| \__ \ | | | | | (_| | | | | |_
|_.__/ \__,_|___/_| |_|_|_|\__, |_| |_|\__|
                           |___/

This bash script enhanced your OSX/Linux console. The console or “terminal” on macOS comes in the basic equipment therefore very slim. This is good as long as you do not work with it every day. If you often go to the console, you should do something for their eyes and install the Solarized colorscheme theme. If you working a lot with GIT, then bashlight can be you a great help. The Bash extension offers you information for Branch and status of your current GIT repositories. Furthermore it contains many commonly used aliases, which allow a fast working on the console.

Let amazed your colleagues!

Installation & Requirements

1. get the source code

cd
git clone https://github.com/vergissberlin/bashlight.git

2. Open your home bash file in editor

~/.bashrc on linux or ~/src/profile on macOS

3. Include bashlight/bashlight with the following line at the end of the bash file

if [ -f ~/bashlight/bashlight ]; then
    . ~/bashlight/bashlight
fi

Optional settings

To install common git and tmux settings are tailored to bashlight simply run:

bash ~/bashlight/install.bash

Supported operating systems

  • Linux
  • macOS
  • Windows with bash shell

Optional dependencies

  • coreutils for a colourful, easy to handle directory listing – apt install coreutils – brew install coreutils

Features

Git management

The background colour represents the git status

  • green = no changes
  • yellow = changes detected
  • red = untracked files

The chess figure represents the branch you are. Git flow is also supported.

  • ♔ = king = master
  • ♙ = pawn = development
  • ♘ = knight = feature
  • ♗ = bishop = hotfix
  • ☂ = umbrella = other

Ohter signs

  • Arrows “⇡⇣” and number behind represent how many commits you are behind/ahead of the remote
  • Display “+” symbol when current branch is changed but uncommited
  • Display current git branch name, or short SHA1 hash when the head is detached

Prompt

  • Platform-dependent prompt symbol for macOS and Linux
  • No need for patched fonts Remote

Additional information

You are able to add informations to you prompt by setting following environment variables.

  1. PS_INFO: (string) e.g. dev/stage/prod.
  2. PS_INFO_BRAND: (string) e.g. info/success/warning/danger

Set this variables in your .bashrc (Linux) ord src/profile (macOS) file like so:

export PS_INFO="stage"
export PS_INFO_BRAND="warning"

Notification

On macOS and Linux, you have the option to send notifications from the console. However, the commands are different for this purpose. bashlight provides you a unified interface. You can play sounds, open the message window and use the voice output.

Play sounds

blPlay Submarine

Say something

blSay "OK Computer. I just understand train station."

Notification messages

alert "This is the title" "... and this is the content"
Notifications

Notifications

Contains configurations for …

  1. Git global config
    • Shortcuts for all commands
    • Enhanced git history with colours with git sl
    • Colours Which harmonize with the colors used as background
    • Branch setting
  • Bash aliases (shortcuts)
    • directory
      • ll, la, l
      • cd .. = .. < … < ….

Git global configuration

It also include a shell script to set common global bash settings. Before you run the file, take a look in the file. The setting included are tailored to bashlight.

Contributers

Support or Contact

You can contact me (@vergissberlin) on GitHub. Use the issue tracker to report bugs.

Thank you

  • to @riobard, the founder of bash-powrline which this project is based on.
  • to the contributers and testers, who help to further improve the project.
  • Further thanks to GitHub for Atom.io.

Made with love and

Atom.IO