rafi / .config

Rafi's workstations (Archlinux, osx) ~/.config.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Rafael Bodill's macOS/Archlinux dotfiles

This is my entire "dotfiles" configuration for all the software I use on macOS & Archlinux, mostly in the terminal.

I've turned my ~/.config directory into a Git repository and strive to set applications write their configuration there if they don't by default. Meaning, I try to conform to the XDG standard. There is one important caveat in doing so: Secrets can be accidentally committed. I solve this with the clean and smudge filter features of Git attributes.

Features

The most interesting configs:

... And make sure to check out github.com/rafi/vim-config

Install


DO NOT install! These are my customized settings that are tailored to my set-up. If you blindly install it, you won't have a good time.


There is no installation script, only two symlinks:

# Clone the .config repo
cd ~
git clone --recursive git@github.com:rafi/.config.git

# Symlink few files manually:
cd ~
ln -s .config/bash/bashrc .bashrc
ln -s .config/bash/profile .profile

# Create cache directories
mkdir -p ~/.cache/{nvim,pacaur,proselint,xpanes,zoxide}
mkdir -p ~/.cache/{aria2,beets,mpd,mpdscribble,mutt,neomutt,rtorrent,subtitles}
mkdir -p ~/.cache/ncmpcpp/lyrics
mkdir -p ~/.cache/node/{npm,gyp}

# Create user local shared directories
mkdir -p ~/.local/bin
mkdir -p ~/.local/share/{cargo,composer,fonts,go,krew,lf,mailbox,mutt,neomutt}
mkdir -p ~/.local/share/{newsbeuter,newsboat,nextword,tig,vagrant}
mkdir -p ~/.local/share/python/{poetry,pyenv}

macOS-specific Software

on macOS, make sure you check these out:

https://macos-defaults.com/ --- https://github.com/yannbertrand/macos-defaults

XDG Conformity

Configuration directories are organized neatly by defining specific environment variables in bash/exports and aliases in bash/aliases.

Some programs require special aliases to feed the proper config, see "XDG conformity" in bash/aliases.

Protecting Secrets

Using .gitattributes filters clean and smudge. Setup custom filters:

cd ~/.config
git config --local filter.vault.clean 'sed -f ~/.config/clean.sed'
git config --local filter.vault.smudge 'sed -f ~/.config/smudge.sed'

The sed script clean.sed is included. However, you have to create the smudge.sed script yourself, for example:

cat > ~/.config/smudge.sed
s/{{ \(DIANA\|ARIA2\)_TOKEN }}/secret/
s/{{ LASTFM_TOKEN }}/token/
s/{{ LASTFM_PASS }}/password/
s/{{ GIT_NAME }}/Joe Shmoe/
s/{{ GIT_EMAIL }}/name@gmail.com ; personal/
s/{{ GIT_WORK_EMAIL }}/name@gmail.com ; work/
s/{{ JIRA_URL }}/url/
s/{{ JIRA_USER }}/username/
s/{{ JIRA_PASS }}/password/
s/{{ FORECASTIO_TOKEN }}/token/
s/{{ GITHUB_TOKEN }}/token/
s/{{ HOMEBREW_GITHUB_API_TOKEN }}/token/
s/{{ GITLAB_TOKEN }}/token/
s/{{ OPENAI_API_KEY }}/token/
s/{{ DICTIONARY_API_KEY }}/key/
s/{{ TMUX_SPOTIFY_API_KEY }}/token/

Now whenever you stage files, the clean.sed will prevent secrets being committed. And on checkout, the smudge.sed will inject your secrets into their proper placeholders. Note that smudge.sed is ignored from being committed mistakenly.

Create a ~/.config/.secrets.env file with the following format:

export GITHUB_TOKEN="{{ GITHUB_TOKEN }}"
export HOMEBREW_GITHUB_API_TOKEN="{{ HOMEBREW_GITHUB_API_TOKEN }}"
export OPENAI_API_KEY="{{ OPENAI_API_KEY }}"
export DICTIONARY_API_KEY="{{ DICTIONARY_API_KEY }}"
export GITLAB_TOKEN="{{ GITLAB_TOKEN }}"

# And so on…

About

Rafi's workstations (Archlinux, osx) ~/.config.


Languages

Language:Shell 67.6%Language:C 15.5%Language:Python 7.2%Language:Ruby 4.4%Language:Perl 1.5%Language:CoffeeScript 1.3%Language:CSS 0.7%Language:sed 0.7%Language:AppleScript 0.5%Language:Makefile 0.5%