Awesome Dotfiles

Simple, but extensive customization of ZSH, TMUX, and Vim.

Setup Options

There are 3 ways in which you can use this, depending on how much you think you'll be customizing.

One of the key features is that this implementation stays in sync across all your machines. So depending on how much you'd like to customize your configuration, you have a few options:

Little Customization: Just clone this repo and jump to Installation.
Mild Customization: Fork this repo, and clone your own fork. Keep an eye on this repo for bugfixes and other improvements that you'd like to incorporate into your fork. Then jump to Installation.
Most Customization: Building your own dotfiles from scratch! Read through these docs, watch the video above, star this repo, and create your own dotfiles! You can add this repository as a git module and source the parts you like.

If you're unsure, just read the docs, watch the video, clone this repository, and jump to Installation.

Installation

Once the repo is cloned, execute the deploy script:

./deploy

This script guides you through the following:

Checks to see if you have zsh, tmux, and vim installed.
Installs them using your default package manager if you don't have some of them installed.
Checks to see if your default shell is zsh.
Sets zsh to your default shell.
Backs up your old configuration files.

Pretty convenient for configuring new servers.

Summary of Changes

Basic runtime operations

All default dotfiles (.zshrc, .vimrc, etc) source something within the dotfiles repository. This helps separate changes that are synced across all your machines with system-specific changes.

Upon launching a new shell, the first thing that's evaluated is zshrc_manager.sh. This script first launches tmux. Then once zsh logs in, within tmux, it updates the dotfiles repository, and sources the changes.

Zsh

cd has been reassigned to cd and ls. Every time you navigate to a new directory, it will display the content of that directory.
v has been aliased too: vim -p. This lets you open multiple files in vim as tabs.

Prompt

The prompt takes on the form:

[plugin, plugin, ...]:

Each plugin is sensitive to where you are and what you're doing, they reveal themselves when it's contextually relevant. Plugins include:

PWD plugin: always present, tells you where you are. Always the first plugin.
Status code plugin: appears anytime a program returns with a non-zero status code. Tells you what status code the program completed with.
Git plugin: appears when you're in a git repository. Tells you what branch you're on, and how many files have been changed since the last commit.
Sudo plugin: tells you when you can sudo without a password. Or when you're logged in as root.
Time plugin: appears when a program took more than 1s to execute. Tells you how long it took to execute.
PID plugin: appears when you background a task. Tells you what the PID of the task is.

Keybindings

Key Stroke	What It Does
Ctrl-H	Goes to the root of a git project, runs `cd $(git rev-parse --show-toplevel
Ctrl-K	Runs `cd ..`
Ctrl-G	Runs `git add -A; git commit -v && git push`
Ctrl-V	Runs `fc`. Takes last command and puts it in a vim buffer.
Ctrl-S	Adds `sudo` to the beginning of the buffer.
Ctrl-L	Runs `ls`.
Ctrl-O	Equivalent to hitting `Enter`.
Ctrl-P	Equivalent to pressing `Up Arrow`.

Plugins

zsh-autosuggestions: Searches your history while you type and provides suggestions.
zsh-syntax-highlighting: Provides fish style syntax highlighting for zsh.
ohmyzsh: Borrowed things like tab completion, fixing ls, tmux's vi-mode plugin.
vimode-zsh allows you to hit esc and navigate the current buffer using vim movement keys.

Vim

Leader key has been remapped to ,

Tmux

Ctrl-B has been remapped to the backtick character (`). If you want to type the actual backtick character (`) itself, just hit the key twice.
% has been remapped to v.
Use vim movement keys for moving between panes.
Copy buffer is copied to xclip.
Status bar tells you date, time, user, and hostname. Especially useful with nested ssh sessions.

Parth/dotfiles