dotfiles

Collection of dotfiles that can be used to quickly setup a new macOS.

Table of Contents

• How to install
  • Install dependencies
• How to uninstall
• Usage
  • dot
  • dot-install
  • dot-uninstall
  • dot-sync
  • dot-add-env

How to install

This repo requires both git and stow to be installed on the target machine.

If so, run:

export $DOTFILES_REPO_DIR=$HOME/dotfiles
git clone git@github.com:pasquale95/dotfiles.git $DOTFILES_REPO_DIR
cd $DOTFILES_REPO_DIR

# install dotfiles (without the deps)
./install.sh

The installation process fails if there are conflicting files. In that case, run:

# backs up conflicting files and forces installation
./install.sh --force

Install dependencies

Some aliases and functions require some packages to be installed. If you want, you can install them by running:

# install dotfiles and dependencies through "brew"
./install.sh --deps

NOTE: the external packages that are needed are installed via brew on both macOS and Linux, to share the same user experience across the platforms.

How to uninstall

To uninstall:

./uninstall.sh

Usage

By installing this repo, you will get some shell functions that can be useful to handle the dotfiles within your shell.

dot

dot allows to quickly go into the dotfiles folder:

# go to $DOTFILES_REPO_DIR from anywhere
dot

dot-install

To install dotfiles, run:

dot-install

dot-uninstall

To remove dotfiles, run:

dot-uninstall

dot-sync

To get the latest dotfiles and install them, run:

dot-sync

dot-add-env

You can add a shared environment variable, run:

# this env variable will be synced with the other machines
dot-add-env NEW_ENV_VAR=new_value
# or
dot-add-env NEW_ENV_VAR new_value

If you want to add an environment variable only for the local machine, run:

# this env variable will not be synced with the other machines
dot-add-env --local NEW_ENV_VAR=new_value
# or
dot-add-env --local NEW_ENV_VAR new_value