dot-files

Track and manage Linux dot-files, symlinks, and aliases across machines.

Features:

• Group your aliases into group files in includes/aliases/
• List these aliases using the a pretty-print command
• Customize ~./bashrc by adding to config/bashrc-addons file
• Setup dot file symlinks from your ~ into this repo using setup.sh

Ships with:

• Sample .gitconfig, .vimrc, and .bashrc files.
  • You can add more to the repo's root.
• Bunch of sample aws, pacman, arch, disk, file, git, network, server, etc aliases
  • You can add more to the aliases folder in their own files

Setup

cd ~
git clone git@github.com:bill-c-martin/dot-files.git
chmod +x dot-files/setup.sh
./dot-files/setup.sh

The setup script asks if it can point your ~ dot files to the versions in this repo (or any other files you add to this repo starting with a .):

• .gitconfig
• .vimrc
• .bashrc

The setup script also will offer to append an include in ~/.bashrc for this repo's aliases and .bashrc customizations.

From there, refresh bash:

. ~/.bashrc

Install bat for pretty-printing:

sudo apt install bat

Usage

Alias Usage

Aliases are grouped in files under ~/.dotfiles/bash/aliases/*.

Print alias groups:

a

Example output:

Usage: a <alias-group>

Where <alias-group> is one of: 

alias-browser
arch
aws
disk
docker
files
general
git_aliases
gnome
gw
network
pacman
permissions
server

View aliases for a particular <alias-group> from above output:

a <alias-group>

Example:

a pacman

Example output:

Aliases in /home/bill/dot-files/includes/aliases/pacman:

───────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
       │ File: /home/bill/dot-files/includes/aliases/pacman
───────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
   1   │ # Install/uninstall
   2   │ alias pacman-install='sudo pacman -Syu'   # append package name
   3   │ alias pacman-uninstall='sudo pacman -Rsc' # append package name
   4   │ 
   5   │ # What do I have?
   6   │ alias pacman-installed='pacman -Q'
   7   │ alias pacman-installed-info='pacman -Qi'  # append package name
   8   │ alias pacman-orphaned='pacman -Qdt'
   9   │ 
  10   │ # Finding packages
  11   │ alias pacman-search='pacman -Ss'          # append package name
  12   │ alias pacman-search-info='pacman -Si'     # append package name
  13   │ 
  14   │ # Update/upgrade
  15   │ alias pacman-update='sudo pacman -Syy'
  16   │ alias pacman-upgrade='sudo pacman -Syu'
  17   │ 
  18   │ # Cache
  19   │ alias pacman-clean-cache='pacman -Sc'

Dot File Usage

To track a new dot file, add it to the root of this repo, then run setup.sh which will symlink your dot file from ~/ to the one in this repo.

Example: Move .gitconfig to be Tracked in This Repo

cp ~/.vimrc ~/dot-files/.gitconfig
cd ~ && ./dot-files/setup.sh

Output:

# Setting up dot file symlinks..

Symlinked: ~/.gitconfig -> ~/dot-files/.gitconfig

# Next Steps: 

- Refresh bash: . ~/.bashrc
- View aliases: a

Example: Track a Brand New .vimrc File in This Repo

Where ~/.vimrc does not yet exist.

echo "set tabstop=4 shiftwidth=4 expandtab" > ~/dot-files/.vimrc
cd ~ && ./dot-files/setup.sh

Output:

# Setting up dot file symlinks..

Symlinked: ~/.vimrc -> ~/dot-files/.vimrc

# Next Steps: 

- Refresh bash: . ~/.bashrc
- View aliases: a