gitmyhub

dotfiles

Lua ★ 3 updated 2mo ago

Dead simple dotfiles

What This Does

This is a tool that helps you manage your personal configuration files—things like your shell settings, editor preferences, and other dotfiles that live in your home directory. Instead of manually copying files around or remembering where everything goes, this repo lets you keep all your configs in one organized place and automatically link them where your computer expects to find them.

How It Works

The idea is straightforward. You put your configuration files in a files folder and name them with a .symlink extension. When you run a command, the tool creates symlinks (think of them as shortcuts or aliases) that point from your home directory to these files. For example, a file called bashrc.symlink becomes .bashrc in your home folder, ready for your shell to use. If you need to update a config, you edit it in the repo and the changes are immediately available everywhere because of the symlink.

The project includes a safeguard: if you already have a config file in your home directory, the tool won't overwrite it by default. You can force it to replace existing files by setting a flag when you run the sync command.

Who Uses This and Why

This is useful for anyone who wants to version-control their personal setup and easily replicate it across multiple computers. A developer might keep all their shell configurations, git settings, and editor preferences in a single dotfiles repo. When they get a new laptop, they can clone the repo and run one command to set everything up instead of manually recreating each file. It's also handy for backing up your configurations and sharing them with teammates who use similar tools.

The "dead simple" philosophy here means there's no complex logic or special configuration needed—just file naming conventions and a basic sync script. This makes it easy to understand and modify if you have specific needs.