Skip to content

akroeger1984/dotfiles-light

BranchesTags
 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
ps1
ps1
 
 
rc
rc
 
 
scripts
scripts
 
 
startup-sequence
startup-sequence
 
 
.gitignore
.gitignore
 
 
LICENSE.txt
LICENSE.txt
 
 
README.md
README.md
 
 
profile
profile
 
 

Repository files navigation

Version Version

Dotfiles LIGHT

Hello and welcome to my latest Dotfiles for BASH environment. This is the super-light edition.

Features

Common Features

  • Highly configurable prompt shell features
  • Enhanced history, formatted output, continuous history across terminal tabs.
  • Auto included PATH information. ~/bin, /usr/local/sbin and more.
  • Auto load for rbenv, pyenv, pip
  • Special prompts: git, hg, ip_list, ruby/rbenv, python/pyenv, django, virtualenv
  • Bash completions: bundler, django-admin, manage.py, gem, hg, rake, printev, pip
  • ~/.inputrc
  • Colorful file lists!
  • Colorful man and less output!
  • Enable of disable color feature!

OSX Only Features

  • Autoload for brew: bash-completion
  • Linux style file listing if coreutils installed from brew (folders on top!)
  • Bunch of useful alias examples.

Common aliases

Try these commands:

  • rm, mv, rmdir, mkdir: You need to confirm!
  • cp: Preserve attributes and copy verbose by default!
  • l, ll, la: Nice Linux-ish (well 100% same!) lists.
  • what_is_my_ip_opendns, what_is_my_ip: Using dig or curl can tell your real IP address!

OSX aliases

  • desktop_hide, desktop_show: You can show/hide all icons on your desktop via single command!
  • shadow_screenshot_disable, shadow_screenshot_enable: Enable/disable shadows while taking screenshots!
  • ds_store_clear: Delete .DS_Store files :)
  • lock_screen: Going for lunch? lock it asap!

Common functions/commands

  • dataurl: Data url for image file: dataurl my_picture.jpg
  • gz_analyse: Analyses gzipped/non-gzipped versions of a file: gz_analyse my_file.txt
  • mkdir_cd: Create folder and cd in to it: mkdir_cd foo
  • webserver: That folder becomes a website! (via python): cd /folder/;webserver
  • webserver_rb: That folder becomes a website! (via ruby): cd /folder/;webserver

Install & Uninstall

Requirements for OSX

All you need is git. If you have Homebrew installed, you can add these packages (they are not required):

brew install git-extras coreutils

Requirements for Ubuntu and Gentoo

Need git only!

sudo apt install -y git-core # Ubuntu
sudo emerge dev-vcs/git      # Gentoo

Install:

git clone https://github.com/vigo/dotfiles-light.git $HOME/Dotfiles
bash $HOME/Dotfiles/scripts/install.bash
# Restart your Terminal

Remove:

bash $HOME/Dotfiles/scripts/uninstall.bash
# Restart your Terminal

Configuration

There is almost no-configuration :) There are few extras if you like to use. Put all your custom/private stuff under private/ folder. (Root of the repo)

.
├── private/               ---> your private stuff folder!
├── ps1/
├── rc/
├── scripts/
├── startup-sequence/
├── LICENSE.txt
├── README.md
├── options                ---> your private flags set/unset variables or functions
└── profile

When you clone the repo, you won’t see options file and private/ folder. They are both in .gitignore. If ~/Dotfiles/options file exists, bashrc will load it first. Everything under private/ folder will be loaded last.

By default, color features are enabled. If you don’t like to use it just un-set some BASH variables in options file.

cd $HOME/Dotfiles
touch options

# open options and
unset DFL_LS_COLOR    # disables `ls` colors
unset DFL_LESS_COLOR  # disables `man` colors
unset DFL_PS1_COLORS  # disables `PS1` colors

Put all your private aliases, env and your custom ps1 files under private/ folder. Here is an example:

cd $HOME/Dotfiles
mkdir private
cd private
touch ps1

# open ps1
CUSTOM_PS1="${PROMPT_HORIZONTAL_LINE}
${PROMPT_MEMORY}${PROMPT_BATTERY}
${PROMPT_USER_AND_HOSTNAME}
${PROMPT_DATABASE_STATUS}${PROMPT_VIRTUALENV}${PROMPT_RUBY_RBENV}${PROMPT_PYTHON_PYENV}${PROMPT_GIT}${PROMPT_HG}
$ "

export PS1="${CUSTOM_PS1}"

PS1 ELEMENTS

Color Configuration

You can set the color of every-bit in PS1. Available color and style variables are defined under startup-sequence/sample-ps1-colors. General color names (variables) are stored under startup-sequence/colors:

${black}
${red}
${green}
${yellow}
${blue}
${magenta}
${cyan}
${white}
${gray}

Styles are:

${bold}
${underline}
${reverse}
${blink}

Predefined formats are:

${white_on_blue}
${white_on_red}
${white_on_black}

You can even combine them:

export DFL_RBENV_PROMPT_COLOR="${bold}${yellow}${blink}"

You can create a copy of sample colors for customization:

cp ${HOME}/Dotfiles/startup-sequence/sample-ps1-colors ${HOME}/Dotfiles/private/my-colors

Example color and variable names:

export DFL_HORIZONTAL_LINE_PROMPT_COLOR="${gray}"                      # [------]
export DFL_BASH_VERSION_INFO_PROMPT_COLOR="${gray}"                    # [4.4.5(1)-release]
export DFL_MEMORY_PROMPT_COLOR="${green}${bold}"                       # [2.43G]

# vigo at noto.local in ~
export DFL_USER_HOSTNAME_USER_PROMPT_COLOR="${blue}"
export DFL_USER_HOSTNAME_HOSTNAME_PROMPT_COLOR="${red}"
export DFL_USER_HOSTNAME_CWD_PROMPT_COLOR="${white}"

# git/hg
export DFL_REVCONTROL_BRANCH_COLOR="${green}"                          # master
export DFL_REVCONTROL_AT_SIGN_COLOR="${white}"                         # @
export DFL_REVCONTROL_COMMIT_ID_COLOR="${underline}"                   # 4a449eb1d5e5
export DFL_REVCONTROL_UNTRACKED_COLOR="${red}"                         # □
export DFL_REVCONTROL_ADDED_COLOR="${yellow}${bold}"                   # ■
export DFL_REVCONTROL_MODIFIED_COLOR="${green}"                        # ◆
export DFL_REVCONTROL_RENAMED_COLOR="${yellow}"                        # ◇
export DFL_REVCONTROL_DELETED_COLOR="${blink}${magenta}"               # ◌
export DFL_REVCONTROL_TYPECHANGED_COLOR="${cyan}"                      # ❖
export DFL_REVCONTROL_OVERALL_COLOR="${white}"                         #
export DFL_REVCONTROL_VERTICAL_PIPE_COLOR="${gray}"                    # |
export DFL_REVCONTROL_GIT_BRANCH_AHEAD_COLOR="${reverse}${white}"      # →
export DFL_REVCONTROL_GIT_BRANCH_BEHIND_COLOR="${reverse}${white}"     # ←

# battery
# export DFL_BATTERY_ICON="\xE2\x8C\xA7" # for custom icon :)          # [⌧ 7:48]
export DFL_BATTERY_PROMPT_COLOR="${yellow}"                            # [3:47]

# ip list
export DFL_IPLIST_PROMPT_IFACE_COLOR="${gray}${bold}"                  # [en0:192.168.2.205,vboxnet0:192.168.33.1]
export DFL_IPLIST_PROMPT_IPADDR_COLOR="${gray}"

# database status
export DFL_DB_MYSQL_PROMPT_COLOR="${red}${blink}"                      # [MySQL]
export DFL_DB_POSTGRESQL_PROMPT_COLOR="${red}${blink}"                 # [PG]
export DFL_DB_REDIS_PROMPT_COLOR="${red}${blink}"                      # [REDIS]

# libs
export DFL_VIRTUALENV_PROMPT_COLOR="${red}${bold}"                     # [⚑ resume.bilgi.edu.tr]
export DFL_RBENV_PROMPT_COLOR="${yellow}"                              # [◆ 2.3.3]
export DFL_PYTHON_PROMPT_COLOR="${blue}"                               # [¶ 2.7.12]
export DFL_DJANGO_PROMPT_COLOR="${cyan}${underline}"                   # [❡ 1.10.1]

${PROMPT_MEMORY}

OSX only. Displays remaining free memory: [2.90G]. Color variable is DFL_MEMORY_PROMPT_COLOR

${PROMPT_BATTERY}

OSX only. Displays remaining hour(s) on battery mode: [2:05]. Color variable is DFL_BATTERY_PROMPT_COLOR. You can set a custom icon via setting DFL_BATTERY_ICON variable. Example:

export DFL_BATTERY_ICON="\xE2\x8C\xA7" # ⌧

${PROMPT_USER_AND_HOSTNAME}

Outputs USERNAME at HOSTNAME in CURRENT_WORKING_DIRECTORY. Color variables are:

  • DFL_USER_HOSTNAME_USER_PROMPT_COLOR
  • DFL_USER_HOSTNAME_HOSTNAME_PROMPT_COLOR
  • DFL_USER_HOSTNAME_CWD_PROMPT_COLOR

You can change the variables. See details (osx/bsd) via man -P 'less -p ^PROMPTING' bash

PROMPT_USER_AND_HOSTNAME="${DFL_USER_HOSTNAME_USER_PROMPT_COLOR}\u${COLOR_OFF} at ${DFL_USER_HOSTNAME_HOSTNAME_PROMPT_COLOR}\H${COLOR_OFF} in ${DFL_USER_HOSTNAME_CWD_PROMPT_COLOR}\w${COLOR_OFF}"

# vigo at noto.local in ~/Dotfiles
# \u at \H in \w

${PROMPT_GIT}

This works if you are under a git repository. Shows current status such as; added, modified, deleted, renamed, type changed files amount. Example:

[master @ 297c543ceac8 □:1 ◆:1 ◌:1 | 3]
   |      |            |   |   |     |
   |      |            |   |   |     +-> 3 files will be affected   
   |      |            |   |   +-------> 1 file is deleted
   |      |            |   +-----------> 1 file is modified
   |      |            +---------------> 1 file is untracked
   |      +----------------------------> commit id
   +-----------------------------------> current branch

[development @ b09ab92a87d5 □:1 | 1 →1]
                                    |
                                    +--> this branch is ahead of 'origin/development'
                                         by 1 commit. you need to push it now! :)
□ : untracked
■ : added
◆ : modified
◇ : renamed
◌ : deleted
❖ : type changed

git prompt also shows how many commit you are ahead/behind against your tracking remote. If you are in a rebase/bare/conflict mode, git prompt shows it to you :)

${PROMPT_HG}

Mercurial version of ${PROMPT_GIT}. Example:

[default @ b63bcee9d5ee+:1+ □:1 ■:2 ◌:2]
    |      |             |  |   |   |
    |      |             |  |   |   +--> 1 file is removed/deleted
    |      |             |  |   +------> 1 file is added
    |      |             |  +----------> 1 file is untracked
    |      |             +-------------> local revision number
    |      +---------------------------> global revision id
    +----------------------------------> current branch
    
□ : untracked
■ : added
◆ : modified
◌ : deleted

Color variables for ${PROMPT_GIT} and ${PROMPT_HG} are same:

  • DFL_REVCONTROL_BRANCH_COLOR
  • DFL_REVCONTROL_AT_SIGN_COLOR
  • DFL_REVCONTROL_COMMIT_ID_COLOR
  • DFL_REVCONTROL_UNTRACKED_COLOR
  • DFL_REVCONTROL_ADDED_COLOR
  • DFL_REVCONTROL_MODIFIED_COLOR
  • DFL_REVCONTROL_RENAMED_COLOR
  • DFL_REVCONTROL_DELETED_COLOR
  • DFL_REVCONTROL_TYPECHANGED_COLOR
  • DFL_REVCONTROL_OVERALL_COLOR
  • DFL_REVCONTROL_VERTICAL_PIPE_COLOR
  • DFL_REVCONTROL_GIT_BRANCH_AHEAD_COLOR
  • DFL_REVCONTROL_GIT_BRANCH_BEHIND_COLOR

${PROMPT_RBENV}

Shows current Ruby version if you are using rbenv or any existing/installed ruby binary available. Color variable is DFL_RBENV_PROMPT_COLOR.

[◆ 2.4.0] # Ruby version 2.3.3 is active!

${PROMPT_PYENV}

Shows current Python and Django versions if you are using pyenv or any existing python binary. Color variables are: DFL_PYTHON_PROMPT_COLOR and DFL_DJANGO_PROMPT_COLOR.

[¶ 2.7.12][❡ 1.10.1] # Python 2.7.12 is active!
                     # Django 1.10.1 is active!

${PROMPT_VIRTUALENV}

Shows current virtualenv information if you are using virtualenv. This would be kool if you set this: export VIRTUAL_ENV_DISABLE_PROMPT=1 somewhere in your private/ area...Color variable is DFL_VIRTUALENV_PROMPT_COLOR.

[⚑ my_awesome_env] # :)

${PROMPT_BASH_INFO}

Shows current bash version. Color variable is DFL_BASH_INFO_PROMPT_COLOR.

[4.4.5(1)-release] # I need to see this sometimes!

${PROMPT_LIST_IPS}

Shows current available local ip list. Color variables are DFL_IPLIST_PROMPT_IFACE_COLOR and DFL_IPLIST_PROMPT_IPADDR_COLOR.

[en0:192.168.2.205,vboxnet0:192.168.33.1]
# name of interface: IP

This function sometimes takes more time. You can call it manually if you like to:

bash ~/Dotfiles/ps1/ip-list && echo

${PROMPT_DATABASE_STATUS}

OSX only, shows if MySQL or PostgreSQL or Redis server is running. Color variables are:

  • DFL_DB_MYSQL_PROMPT_COLOR

  • DFL_DB_POSTGRESQL_PROMPT_COLOR

  • DFL_DB_REDIS_PROMPT_COLOR

    [MySQL][PG][REDIS] # Helps you to remember is server is on/off

${PROMPT_HORIZONTAL_LINE}

Draws dashed line along the terminal width. This separates commands. Color variable is DFL_HORIZONTAL_LINE_PROMPT_COLOR.

Pre Defined PS1 Examples

PS1_OSX_BASIC and PS1_OSX_ADVANCED

PS1_OSX_BASIC="${PROMPT_MEMORY}${PROMPT_BATTERY}
${PROMPT_USER_AND_HOSTNAME}
${PROMPT_GIT}${PROMPT_HG}
$ "

PS1_OSX_ADVANCED="${PROMPT_HORIZONTAL_LINE}
${PROMPT_MEMORY}${PROMPT_BATTERY}
${PROMPT_USER_AND_HOSTNAME}
${PROMPT_DATABASE_STATUS}${PROMPT_VIRTUALENV}${PROMPT_RUBY_RBENV}${PROMPT_PYTHON_PYENV}${PROMPT_GIT}${PROMPT_HG}
$ "

PS1_UBUNTU_BASIC and PS1_UBUNTU_ADVANCED

PS1_UBUNTU_BASIC="${PROMPT_USER_AND_HOSTNAME}
${PROMPT_GIT}${PROMPT_HG}
> "

PS1_UBUNTU_ADVANCED="${PROMPT_HORIZONTAL_LINE}
${PROMPT_USER_AND_HOSTNAME}
${PROMPT_VIRTUALENV}${PROMPT_RUBY_RBENV}${PROMPT_PYTHON_PYENV}${PROMPT_GIT}${PROMPT_HG}
> "

PS1_GENTOO_BASIC and PS1_GENTOO_ADVANCED

PS1_GENTOO_BASIC="${PROMPT_USER_AND_HOSTNAME}
${PROMPT_GIT}${PROMPT_HG}
-> "

PS1_GENTOO_ADVANCED="${PROMPT_HORIZONTAL_LINE}
${PROMPT_USER_AND_HOSTNAME}
${PROMPT_VIRTUALENV}${PROMPT_RUBY_RBENV}${PROMPT_PYTHON_PYENV}${PROMPT_GIT}${PROMPT_HG}
-> "

Build your own!

Just drop a file under ~/Dotfiles/private/my-ps1 thats it! Your options:

${PROMPT_HORIZONTAL_LINE}
${PROMPT_MEMORY}
${PROMPT_BATTERY}
${PROMPT_USER_AND_HOSTNAME}
${PROMPT_DATABASE_STATUS}
${PROMPT_VIRTUALENV}
${PROMPT_RUBY_RBENV}
${PROMPT_PYTHON_PYENV}
${PROMPT_GIT}
${PROMPT_HG}
${PROMPT_LIST_IPS}
${PROMPT_BASH_INFO}

Make yours:

# on ~/Dotfiles/private/my-ps1
MY_CUSTOM_PS1="${PROMPT_USER_AND_HOSTNAME}
${PROMPT_GIT} $ "

export PS1="${MY_CUSTOM_PS1}" # that’s it!

less and man Colors

Check the file ~/Dotfiles/startup-sequence/less-colors:

export LESS_TERMCAP_md="${yellow}${bold}"         # bold text
export LESS_TERMCAP_us="${green}${underline}"     # start underline
export LESS_TERMCAP_so="${white_on_blue}"         # start standout (reverse video)

export LESS_TERMCAP_me="${COLOR_OFF}"             # turn off bold, blink and underline
export LESS_TERMCAP_se="${COLOR_OFF}"             # stop standout
export LESS_TERMCAP_ue="${COLOR_OFF}"             # stop underline

Color values such as ${yellow}, ${green} they all are coming from PS1 color setup. You can customize it easily. All you need is to set LESS_TERMCAP_XX variable. XX can be md, us etc... More details can be found here

Use defaults or add yours under ~/Dotfiles/private/my-less-colors.

HISTTIMEFORMAT

You can customize how your history will look :) Default is:

export HISTTIMEFORMAT="[${green}%A at ${white}${underline}%T${COLOR_OFF}]: "
# [Tuesday at 23:32:10]: cd Dotfiles/
#  |          |
#  +-> green  |
#             +-> white + underlined

History uses strftime, you can check options via man 3 strftime. Keep this in mind, always use styling variables after color definition:

# example
${blue}${bold}
${green}${link}

This also applies PS1 Coloring too...

Contributer(s)

Contribute

All PR’s are welcome!

  1. fork (https://github.com/vigo/dotfiles-light/fork)
  2. Create your branch (git checkout -b my-features)
  3. commit yours (git commit -am 'added killer options')
  4. push your branch (git push origin my-features)
  5. Than create a new Pull Request!

License

This project is licensed under MIT

About

Just another but `lighter` version of BASH environment

Resources

Readme

License

MIT license
Activity

Stars

0 stars

Watchers

1 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages

  • Shell 100.0%