.dotfiles

Personal Bash shell configuration files and scripts.

Supported OS

• Ubuntu 22.04 LTS
• Ubuntu 20.04 LTS in WSL2
• Ubuntu 22.04 LTS in WSL2
• macOS 13 on Apple Silicon

Prerequisites

Dotfiles require:

• Bash >= 4.3
• GNU awk
• GNU Coreutils
• perl

Building and installing requires:

• GNU make
• Docker and docker-compose, or Docker Desktop

On macOS

On macOS, you may want:

• Xcode
• Homebrew package manager

You can then use Homebrew to install bash and coreutils.

Install

It is expected that dotfiles are accessible through ~/.dotfiles, either by a link or otherwise. Clone the repository to that location and run the installer, which creates symbolic links to your home directory:

$ git clone https://github.com/gocom/dotfiles.git ~/.dotfiles && cd ~/.dotfiles
$ make install

The above requires Docker and docker-compose. Docker is used for building man pages and other assets, without placing hard requirements on the host system.

If you do not require man pages or other assets, and just want to symlink dotfiles to your home directory, you can run:

$ make link

The above avoids Docker requirement and all actions are performed on the host system.

Customizing Bash configuration

Local Bash configuration can be customized from ~/.bash_login, ~/.bash_aliases and ~/.bash_config files. If one of these exists, it is included in the login shell bashrc and never overwritten by the installer.

echo 'export EDITOR=/usr/local/bin/atom' >> ~/.bash_config

Configuring git

Local git config can be provided with ~/.gitconfig_local.

git config --file ~/.gitconfig_local user.email [email protected]
git config --file ~/.gitconfig_local user.name "Foo Bar"