dotfiles

Shared dotfiles between machines, managed by chezmoi.

Why?

I'm building this repository in order to create a consistent shell environment on whichever machine i may be using. I'm currently learning to use vim so that I can be productive no-matter the environment/machine im currently working on.

Supported operating systems

This is my standard set of applications + configuration and is designed to run on my OS's of choice.

This has been tested on:

• MacOS (Sonoma+)
• Ubuntu Linux 24.04+
• Windows 11 (WSL with Ubuntu 24.04)

It also has had limited testing on Android using the [Termux app located on F-Droid. This is still not in a working state as of yet however.

Dependencies

While the dotfiles repo is designed to be a one-command install, there are a few dependencies that must be setup first

Ubuntu

If running on Linux you will need to install the following packages:

• zsh - should be installed and set as your default shell.
• git - for cloning the repo
• curl or wget - for downloading the install script

A quick one liner to install all the above dependencies is below

sudo apt-get update && sudo apt-get -y install zsh git wget curl && sudo chsh -s /usr/bin/zsh $(whoami)

You'll need to restart your system afterwards to have zsh as your default shell. Otherwise, you can run zsh manually in your terminal to switch (select the option to create an empty ~/.zshrc file) and continue with the installation.

Mac OS

If running on a Mac you will need to install the Xcode command line tools

xcode-select --install

Windows

If running on Windows you will need to install WSL and Ubuntu 24.04. You will also need to install the following packages:

• zsh
• git
• curl or wget

Android

Finally, if running on Android, you will need to install the Termux app from F-Droid. You will also need to install the following packages:

• zsh
• git
• curl or wget

Install

Install everything with:

curl

sh -c "$(curl -fsLS https://raw.githubusercontent.com/twitchel/dotfiles/master/install.sh)"

wget

sh -c "$(wget -qO- https://raw.githubusercontent.com/twitchel/dotfiles/master/install.sh)"

There are some config flags you can set via environment variables

DOTFILES_BRANCH=feature/git-branch-for-testing
DOTFILES_DEBUG=true
DOTFILES_VERBOSE=true

You will need to restart your terminal session afterwards.