Skip to content

KaBankz/dotfiles

Repository files navigation

~./dotfiles

Get Started 🚀

bash -c "$(curl -fsSL https://github.com/KaBankz/dotfiles/raw/dotter/setup.sh)"

Script Source Code: setup.sh

Key Features 🔑

🐠 Fish Shell — I use the Fish Shell as my default shell, with a heavily customized config following fish best practices.

  • I documented most of my findings in my fish README.
  • I've spent WAY too much time configuring fish 😅

🏠 XDG Base Directory — I follow the XDG Base Directory Specification for my dotfiles.

  • I have gone through great lengths to ensure that all my dotfiles are not scattered throughout my home directory. (Check fish env vars)

🍺 Homebrew — I use Homebrew to manage my packages on macOS.

  • I have a Brewfile that contains all the packages I use.

📦 Dotter — I use Dotter to manage my dotfiles.

  • I have tried MANY dotfile managers, and Dotter is the one that I like the most.

Manual Installation 🛠️

Click to expand
  1. Clone this repo

    git clone https://github.com/KaBankz/dotfiles.git ~/.dotfiles
  2. Go to the repo and stay there until the end

    cd ~/.dotfiles

    IMPORTANT: You must create a local.toml file inside the .dotter directory.

    This file is used to store your local configurations.

    You can copy the local.toml.example or any host config file from .dotter and modify it to your needs.

    cp .dotter/local.toml.example .dotter/local.toml
  3. Download the dotter binary inside the repo

    WARNING: Be sure to download the appropriate binary for your os and arch from Dotter Releases.

    curl -fsSL -o dotter https://github.com/SuperCuber/dotter/releases/latest/download/dotter-macos-arm64.arm
    chmod +x dotter
  4. Run dotter deploy inside the repo

    The -v flag is optional, it enables verbose output to see what is happening.

    CAUTION: If you have any existing dotfiles that conflict with the ones in this repo, you will receive an error. You can either remove the conflicting dotfiles or overwrite them using --force.

    ./dotter deploy -v

License 📜

MIT