__      __  _______ __
      ____/ /___  / /_/ ____(_) /__  _____
     / __  / __ \/ __/ /_  / / / _ \/ ___/
    / /_/ / /_/ / /_/ __/ / / /  __(__  )
    \__,_/\____/\__/_/   /_/_/\___/____/

Container-based Installation

Use the packaged container to install dotfiles and all dependencies.

Run this:

git clone https://github.com/ssbanerje/dotfiles.git
./dotfiles/scripts/shim.sh <command>

Details

• Script uses docker to run the container.
• By default, the shim will use an Ubuntu container.
• For an Archlinux container use scritps/shim.sh -archlinux <command>
• Shim passes ssh-agent keys to container.
• Shim mounts host's current working directory to /cwd.

Local Installation

Install the dotfiles and dependencies on the local machine.

Run this:

git clone --recurse-submodules https://github.com/ssbanerje/dotfiles.git
cd dotfiles
./install_profile <profile>

Details

• Update configuration files for user.
  • meta/config/git.yaml
• The installer script can load profiles located in meta/profiles/:
  • macos: For MacOS
  • ubuntu: For Ubuntu desktop
  • ubuntu-minimal: For text-based Ubuntu distributions
  • archlinux-minimal: For text-based Archlinux distributions
• To install individual components (from meta/config/) use the install.sh script.
• Once installed, the scripts/shim.sh script is accessible as the shim command.

Setup Development Environment

Install pre-commit hooks:

pip install pre-commit
pre-commit install