/dotfiles

Dotfiles for macOS and Debian

Primary LanguageShell

My homies ese! 😎

A tidy $HOME is a tidy mind.

Neofetch - Aug-2018 Screenshot of macOS High Sierra

Workflow - Aug-2018 Screenshot of macOS High Sierra

These are my dotfiles, designed primarily for macOS and *Debian (well... it has only been tested on Ubuntu Server ¯\_(ツ)_/¯), heavily inspired by hlissner/dotfiles. They are my specific breed of madness, split into 2-level topics (e.g. shell/zsh) that strive for minimum $HOME presence (adhering to XDG standards where possible).

Quick start

bash <(curl -s https://raw.githubusercontent.com/eduarbo/dotfiles/master/bootstrap.sh)

What does it include?

The following are the categories and topics available to install:

  • macos/ - macOS compatible utilities

    • apps - collection of macOS apps that I use on a daily basis
    • defaults - bare essentials for macOS
    • hammerspoon - a bunch of lua scripts to boost my productivity
    • iterm - iTerm2, is there a better macOS terminal?
    • kitty - well, in fact there is a better macOS terminal
    • karabiner - powerful keyboard customizer

  • misc/ - Very handy apps & tools

    • surfingkeys - vim-like bindings for Google Chrome & Firefox
    • gnupg - encryption/signing

  • editor/ - Configuration for my text editors

    • editorconfig - maintain consistent coding styles between different editors
    • emacs - the best of Emacs and Vim in one place
    • vim - for quick file editing

  • shell/ - Shell utilities

    • bash - not my default shell but doesn't hurt to have a basic config
    • git - nice aliases and zsh plugins
    • tmux - window manager within the terminal + nice plugins
    • zsh - my shell of choice, fast, powerful and with a nice prompt

  • dev/ - Relevant to software development & programming in general

    • lua - manage lua environments with luaenv
    • node - setup nodenv, a lightweight alternative to nvm
    • python - setup pyenv, a simple Python version management

Dotfile management

Usage: deploy [-acdlLit] [TOPIC...]

  -a   Target all enabled topics (ignores TOPIC args)
  -c   Afterwards, remove dead symlinks & empty dot-directories in $HOME.
       Can be used alone.
  -d   Unlink and run `./_init clean` for topic(s)
  -l   Only relink topic(s) (implies -i)
  -L   List enabled topics
  -i   Inhibit install/update/clean init scripts
  -t   Do a test run; do not actually do anything

e.g.

  • deploy misc/kitty shell/{zsh,tmux}: enables misc/kitty, shell/zsh & shell/tmux
  • deploy -d shell/zsh: disables shell/zsh & cleans up after it
  • deploy -l shell/zsh: refresh links for shell/zsh (inhibits init script)
  • deploy -l: relink all enabled topics
  • deploy -L: list all enabled topics

Here's a breakdown of what the script does:

cd $topic
if [[ -L $DOTFILES_DATA/${topic/\//.}.topic ]]; then
    ./_init update
else
    ln -sfv $DOTFILES/$topic $DOTFILES_DATA/${topic/\//.}.topic

    ./_init install
    ./_init link
fi

Troubleshooting

Signing Git commit with GPG ask passphrase everytime

Make sure the GPG key ID is correct. You can get a list of GPG keys with gpg --list-secret-keys --keyid-format LONG and then set it in Git with git config --global user.signingkey [GPG-key-ID].

More details in Telling Git about your GPG key.

Relevant projects/resources