https://github.com/thomasjo/dotfiles
Configuration files and whatnot
https://github.com/thomasjo/dotfiles
chezmoi dotfiles
Last synced: 3 months ago
JSON representation
Configuration files and whatnot
- Host: GitHub
- URL: https://github.com/thomasjo/dotfiles
- Owner: thomasjo
- License: unlicense
- Created: 2022-04-22T11:09:23.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2025-02-07T07:47:48.000Z (over 1 year ago)
- Last Synced: 2025-03-14T10:32:40.006Z (over 1 year ago)
- Topics: chezmoi, dotfiles
- Language: Shell
- Homepage:
- Size: 103 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# My opinionated dotfiles
I don't recommend cloning this repo and opting into my way of doing things,
unless you intend to use my dotfiles as a foundation for making something that
fits your needs and desires.
Don't fork the repo, instead clone/download the repo and copy whatever files or
blocks of configuration makes sense to you.
## The setup
I use [Chezmoi][chezmoi] to power my dotfiles system. I've tried a bunch of
similar solutions, but Chezmoi is without a doubt the most flexible and
user-friendly tool for managing configurations files. Chezmoi ships as a single,
standalone executable (written in Go), and it supports templating, integrations
with tools such as 1Password, age, etc.
The easiest way to experiment with my dotfiles is to run the following command:
```console
sh -c "$(curl -fsLS get.chezmoi.io)" -- init --apply thomasjo
```
That command downloads and installs the `chezmoi` executable, clones this repo
into `~/.local/share/chezmoi`, and applies my dotfiles to your system. Be aware
that this might override any existing configuration files that have the same filenames unless you pay attention.
You can also install Chezmoi using e.g., `brew install chezmoi`. For all of the package manager options available, see the [Chezmoi install][install] page.
If you've installed Chezmoi using your favorite package manager, run the
following command instead of the one shown initially:
```console
chezmoi init --apply thomasjo
```
I highly recommend reading the [Chezmoi quick start][quick-start], as well as
skimming through the [Chezmoi user guide][user-guide] to familiarize yourself
with "daily" operations, Chezmoi terminology, etc.
## Making my dotfiles your dotfiles
If you've experimented with my dotfiles and you want to make them yours, then I
think one of the easiest routes to follow is to first create your own dotfiles
repo on GitHub (or somewhere else). Make sure the new repo is completely bare,
which means no auto-generated `README.md`, `LICENSE`, or similar files.
After creating your remote repo, navigate to the Chezmoi source directory. An
easy way is to use the `chezmoi cd` command. From the Chezmoi source directory,
you should "re-init" the existing dotfiles repo by first removing the existing
`.git` sub-directory, then initialize an empty, local Git repo. Stage whichever
files you want to keep, commit, and push to your remote repo;
```console
chezmoi cd
rm -rf .git
git init -b main .
git remote add origin
git add
git commit
git push -u origin main
```
Make sure you delete any files you don't want to keep. At this point it's also
a good idea to use commands such as `chezmoi doctor` and `chezmoi [un]managed`
to ensure your dotfiles are properly setup and working as expected.
[chezmoi]: https://www.chezmoi.io/
[install]: https://www.chezmoi.io/install/
[quick-start]: https://www.chezmoi.io/quick-start/
[1password]: https://1password.com/
[age]: https://github.com/FiloSottile/age
[user-guide]: https://www.chezmoi.io/user-guide/command-overview/