These are the base dotfiles that I start with when I set up a new environment (for more specific local needs I use the *.local files).

• 🔧 Setup
• 📸 Screenshots
  • 🔁 Git
  • ⌨️ tmux & Vim
• 💄 Customize
  • 🔀 Forks
  • 🌐 Local Settings
    • 🐚 ~/.bash.local
    • 🔁 ~/.gitconfig.local
    • ⌨️ ~/.vimrc.local
• ↕️ Update
• 📑 License

To set up the dotfiles run the appropriate snippet in the terminal:

That's it! ✨

The setup process will:

• Download the dotfiles on your computer (by default it will suggest ~/projects/dotfiles).
• Symlink the Git, shell, tmux, and Vim related files.
• Install applications / command-line tools for macOS / Ubuntu.
• Set custom macOS / Ubuntu preferences.
• Install the Vim and VS Code plugins.

Setup process in action:

Output for git status:

macOS	Ubuntu

Output for git log:

macOS	Ubuntu

macOS	Ubuntu

The dotfiles can be easily extended to suit additional local requirements by using the following files:

The ~/.bash.local file will be automatically sourced after all the other Bash related files, thus, allowing its content to add to or overwrite the existing aliases, settings, PATH, etc.

Here is an example:

#!/bin/bash

# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

# Set PATH additions.

PATH="/Users/snggeng/projects/dotfiles/src/bin/:$PATH"

export PATH

# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

# Set local aliases.

alias g="git"

The ~/.gitconfig.local file will be automatically included after the configurations from ~/.gitconfig, thus, allowing its content to overwrite or add to the existing Git configurations.

Note: Use ~/.gitconfig.local to store sensitive information such as the Git user credentials, e.g.:

[commit]

    # Sign commits using GPG.
    # https://help.github.com/articles/signing-commits-using-gpg/

    gpgSign = true

[user]

    name = Your Name
    email = account@example.com
    signingKey = XXXXXXXX

The ~/.vimrc.local file will be automatically sourced after ~/.vimrc, thus, allowing its content to add or overwrite the settings from ~/.vimrc.

Here is an example:

" Disable arrow keys in insert mode.

inoremap <Down>  <ESC>:echoe "Use j"<CR>
inoremap <Left>  <ESC>:echoe "Use h"<CR>
inoremap <Right> <ESC>:echoe "Use l"<CR>
inoremap <Up>    <ESC>:echoe "Use k"<CR>

" Disable arrow keys in normal mode.

nnoremap <Down>  :echoe "Use j"<CR>
nnoremap <Left>  :echoe "Use h"<CR>
nnoremap <Right> :echoe "Use l"<CR>
nnoremap <Up>    :echoe "Use k"<CR>

If you decide to fork this project, do not forget to substitute my username with your own in the setup snippets and in the setup script.

To update the dotfiles you can either run the setup script or, if you want to update one particular part, run the appropriate os script.

The code is available under the MIT license.