This public Github repository has been built for my own benefit, however, feel free to sneak in and steal anything that would improve your own productivity.
My plans rely on maintaining a CI workflow alongside GitHub Actions to ensure that my changes will not break across different OS flavours.
The current smoke-test matrix covers the following Linux flavours:
- AlmaLinux 9
- AlmaLinux 10
- Ubuntu 24.04
- Ubuntu 26.04
macOS is verified separately on a GitHub-hosted macOS runner by rendering and applying the repo into a temporary home directory.
I'd not care of using GitHub for backing up my dotfiles if my perspectives of using them remained in a single machine.
You can install this repo via a Convenient script or manually in its defect.
If chezmoi is not installed yet, run the standalone install script directly.
# Using Curl
sh -c "$(curl -fsSL https://raw.githubusercontent.com/kitos9112/dotfiles/master/install)"# OR Using Wget
sh -c "$(wget -qO- https://raw.githubusercontent.com/kitos9112/dotfiles/master/install)"Clone the repo and execute the install script from its root directory.
Leveraging off-the-shelf Chezmoi capabilities
chezmoi init --apply --verbose https://github.com/kitos9112/dotfiles.gitThe root install script accepts environment variables for test and recovery
flows:
DOTFILES_SOURCEuses a local source checkout instead of the remote repo.DOTFILES_REPOoverrides the remote chezmoi repository.DOTFILES_ONE_SHOT=truepasses--one-shotinstead of--apply.DOTFILES_CHEZMOI_INCLUDEandDOTFILES_CHEZMOI_EXCLUDEpass include and exclude filters to chezmoi.DOTFILES_NO_TTY=truepasses--no-tty.DOTFILES_VERBOSE=truepasses--verbose.DOTFILES_DEBUG=truepasses--debug.DOTFILES_RETRY_COUNTandDOTFILES_RETRY_DELAYcontrol retry behavior.DOTFILES_IS_ROOT=true|falseandDOTFILES_IS_WORK=true|falseoverride the default machine inference while rendering chezmoi config. An unrecognisedDOTFILES_IS_ROOTfails the render rather than guessing.
is_root records whether sudo may be used to install system packages (apt,
Homebrew, the 1Password repository). Work machines default to false because
they are often locked down, but many do grant sudo, and those need the packages.
Resolution order is DOTFILES_IS_ROOT, then the value persisted in
~/.config/chezmoi/chezmoi.toml, then false on work machines and true
elsewhere. On a first interactive chezmoi init of a work machine you are asked
once and the answer is stored, so later runs need no environment variable.
To grant sudo on a work machine that was already set up as locked down:
DOTFILES_IS_ROOT=true chezmoi init --applyThe install scripts resolve this through
home/.chezmoitemplates/is-root rather than
reading is_root from the config, because chezmoi only re-renders the config
template on init. Without that, DOTFILES_IS_ROOT=true would be ignored by a
plain chezmoi apply and no packages would install.
Homebrew is a separate decision from sudo. Having root to install apt packages
says nothing about wanting linuxbrew, so use_homebrew is its own flag:
| macOS | Linux | |
|---|---|---|
| Default | on | off |
| Override | DOTFILES_HOMEBREW=true|false |
same |
| Prompt | never | once, on an interactive init |
Resolution mirrors is_root: environment override, then the persisted value,
then the platform default. It lives in
home/.chezmoitemplates/use-homebrew.
So a work machine with sudo installs the apt list and no Homebrew, and a personal Linux box opts in once:
DOTFILES_HOMEBREW=true chezmoi init --applyThe formulae in packages.brew are simply skipped on machines without Homebrew;
they are not reinstalled from another source. Tools that matter everywhere come
from apt, asdf or the Go tool manifest instead.
Portable VS Code, Go and direnv follow use_homebrew being false, not sudo,
because they stand in for Homebrew-installed tooling. A sudo-capable machine that
opted out of brew still gets them.
DOTFILES_PROFILE=desktop|serveroverrides GUI auto-detection (see below). An unrecognised value fails the render rather than guessing.
Every machine resolves to a machine_class of desktop (a GUI is present) or
server (CLI only). Detection order is DOTFILES_PROFILE, then the value
persisted in ~/.config/chezmoi/chezmoi.toml, then GUI auto-detection
(XDG_CURRENT_DESKTOP, DESKTOP_SESSION, WAYLAND_DISPLAY or gnome-shell on
PATH), then server. The logic lives in
home/.chezmoitemplates/machine-class
and is resolved on every render, so a machine whose config predates the setting
still classifies correctly.
What the profile changes:
| Component | desktop |
server |
|---|---|---|
| 1Password | app plus CLI, QR sign-in walkthrough | CLI only, op account add |
| Ghostty | installed and configured | skipped |
Nerd Font and fc-cache |
installed | skipped |
| GNOME dconf settings | imported | skipped |
| AI CLIs, apt/brew packages | installed | installed |
Bootstrap a headless box with no prompts:
DOTFILES_PROFILE=server DOTFILES_NO_TTY=true sh -c "$(curl -fsLS https://raw.githubusercontent.com/kitos9112/dotfiles/master/install)"1Password sign-in is skipped when there is no TTY; finish it later with
op account add on a server, or by signing into the app on a desktop. Nothing in
the bootstrap blocks waiting for input.
apt and Homebrew manifests live in
home/.chezmoidata/packages.yaml, split into
common, desktop and server lists. The installers are run_onchange_
scripts fingerprinted against those lists, so adding a package reaches existing
machines on the next chezmoi apply — not just freshly bootstrapped ones.
Data files must be literal .chezmoidata/*.yaml. chezmoi does not template data
files, so a .chezmoidata.yaml.tmpl is loaded by nothing and its values silently
disappear from the template data.
A curated set of dconf paths is version controlled, listed in
home/.chezmoidata/gnome.yaml. Monitor layout,
window geometry and recently-used files are deliberately excluded so machines do
not fight each other.
task gnome-export # dump the current session's settings into this repo
task doctor # report drift between the repo and the live sessionExports land in home/private_dot_config/dotfiles/gnome/ for review before
committing. On another desktop, chezmoi apply replays them via dconf load.
To get back to a pre-init state and bootstrap again:
dotfiles-reset # dry run: prints exactly what would be removed
dotfiles-reset --yes # remove chezmoi config, state, cache and source checkouttask reset -- --yes does the same. This clears ~/.config/chezmoi (which holds
chezmoistate.boltdb, the run_once and run_onchange bookkeeping),
~/.cache/chezmoi and the source checkout, so every script becomes eligible to
run again. Files already applied into $HOME are deliberately left alone —
removing those would take unmanaged dotfiles with them. Add --keep-source to
reset state while keeping the checkout you are working in.
A first init is not expected to be all-or-nothing: steps that are conveniences
rather than prerequisites (asdf toolchain builds, Homebrew updates, fzf shell
integration, GNOME imports) warn and continue instead of aborting the apply, so
one missing build dependency cannot leave the rest of the dotfiles unapplied.
Run task doctor afterwards to see what actually landed.
task doctorChecks the profile, chezmoi drift, 1Password sign-in, the SSH agent and git signing helper, the AI CLIs, the terminal font, and GNOME drift. Non-applicable checks are reported as skipped; only real breakage sets a non-zero exit code.
Machine-specific values should live in local chezmoi config, not in the public repo. This repo already reads data from ~/.config/chezmoi/chezmoi.toml.
For Git identity, the default profile uses personal_name and personal_email when present. If is_work = true and work_email is set, the machine-wide default becomes the work identity. A work-only Git profile is also available via work_gitdir for path-based overrides.
Example:
[data]
personal_name = "Marcos Soutullo"
personal_email = "personal@example.com"
work_name = "Marcos Soutullo"
work_email = "work@example.com"
work_gitdir = "~/workspace/company/"With that configuration:
~/.gitconfiguses your personal identity by default, or your work identity whenis_work = true.~/.gitconfig-workis rendered automatically.- Git switches to the work identity only for repositories under
work_gitdir.
Existing installations should add those keys to ~/.config/chezmoi/chezmoi.toml and then run chezmoi apply.
The tracked .env file is allowed to exist in this public repository only for
public-safe pointer values, such as 1Password item references. Do not store raw
tokens, credentials, private keys, recovery codes, or machine-confidential
values in .env or any other tracked file.
CI currently does four different checks:
- Linux container smoke tests build the Dockerfiles under
tests/and run the standalone installer inDOTFILES_TEST=truemode. The Ubuntu image pinsDOTFILES_PROFILE=server, which is the headless path. - macOS smoke tests run
chezmoi init --applyandchezmoi verifyagainst a temporary home directory while excluding scripts. - The Go-tool job runs the installer contract test, verifies the module graph, and compiles every declared Go tool with the manifest's pinned Go version.
- The bootstrap-profile job runs
tests/bootstrap-profiles.test.sh, which renders every profile-aware template under both profiles and asserts the desktop/server split, thecreate_seeding of AI CLI configs, and that nogrep --quietsits inside apipefailpipeline. Run it locally withtask test-bootstrap.
To reproduce the macOS-style verification locally:
tmp_home="$(mktemp -d)"
HOME="${tmp_home}" \
XDG_CONFIG_HOME="${tmp_home}/.config" \
XDG_DATA_HOME="${tmp_home}/.local/share" \
XDG_STATE_HOME="${tmp_home}/.local/state" \
XDG_CACHE_HOME="${tmp_home}/.cache" \
DOTFILES_TEST=true chezmoi init --apply --source "$(pwd)" --exclude scripts --no-ttyTo validate hooks locally through uv, run:
uvx pre-commit run --all-filesTo validate the root installer path locally without running mutating scripts:
tmp_home="$(mktemp -d)"
HOME="${tmp_home}" \
XDG_CONFIG_HOME="${tmp_home}/.config" \
XDG_DATA_HOME="${tmp_home}/.local/share" \
XDG_STATE_HOME="${tmp_home}/.local/state" \
XDG_CACHE_HOME="${tmp_home}/.cache" \
DOTFILES_SOURCE="$(pwd)" \
DOTFILES_TEST=true \
DOTFILES_NO_TTY=true \
DOTFILES_CHEZMOI_EXCLUDE=scripts \
./installIf the portable Linux tarball is installed at ~/.apps/vscode, chezmoi now manages the VS Code launcher directly as code:
~/.local/share/applications/code.desktop~/.local/share/applications/vscode-portable.desktop~/Desktop/Visual Studio Code.desktop
The desktop entries prefer a managed local icon named vscode-portable, and a hidden code.desktop alias helps GNOME/Ubuntu match the running VS Code window to the portable launcher.
If ~/.apps/vscode was previously added to chezmoi source state by mistake, remove it once with:
chezmoi forget --force ~/.apps/vscodeChezmoi uses general-purpose scripts to execute ordered operations in the system. They can run either:
- Every time you run
chezmoi apply(runscripts) - When their contents change (
run_onceorrun_onchangescripts)
Bootstrap order on Linux, after the 1Password repository and keys are in place:
| Script | Purpose |
|---|---|
run_onchange_before_03-linux-apt-packages |
apt packages for the resolved profile, then locale-gen |
run_onchange_before_04-linux-brew-packages |
Homebrew and its formulae |
run_once_after_20-1password-signin |
1Password sign-in (app QR, or op account add) |
run_onchange_after_25-install-ghostty |
Ghostty deb, desktop only |
run_onchange_after_30-gnome-settings |
dconf load of the committed settings |
run_onchange_after_35-refresh-font-cache |
fc-cache after the Nerd Font external lands |
run_onchange_after_40-install-ai-clis |
claude, opencode and codex |
The AI CLIs are installed with their own installers so they keep self-updating.
Their baseline configs use chezmoi's create_ attribute, which writes the file
only when it does not already exist — an already-configured machine keeps its
own ~/.claude/settings.json, ~/.config/opencode/opencode.json and
~/.codex/config.toml untouched.
Go-based command-line tools are declared in
home/private_dot_config/dotfiles/go-tools/go.mod.
Chezmoi installs that manifest as ~/.config/dotfiles/go-tools/go.mod, then
run_onchange_after_104-install-go-tools.zsh.tmpl runs go install tool
through the Go version selected by asdf.
The installer reruns only when go.mod, go.sum, or the managed Go runtime
changes. It deliberately clears inherited GOROOT, GOPATH, and GOBIN
before entering the asdf environment, preventing an upgraded compiler from
using the previous Go version's standard library.
Renovate's native Go module manager updates tool requirements in this manifest. Add another Go CLI with Go 1.24 or newer by running:
~/.local/bin/asdf exec go -C home/private_dot_config/dotfiles/go-tools \
get -tool example.com/tool/cmd/tool@v1.2.3Scripts are found in its own directory to avoid being copied over to the target system.
Having a local .git (A.K.A. submodule) folder inside your dotfiles could become dangerous as you're naturally exposing (or unconsciously prompted to) your git history and very specific local configuration. Not even to mention the burden it sometimes signifies.
As I just feed myself from the great works other peers conduct in the wild Internet (e.g. Oh-my-zsh), I'm a mere consumer of their work who clones their source code and thereby uses it.
My scsripts/00_run_once/run_once_100-extras.zsh.tmpl takes care of cloning/pulling(--rebase) their public GitHub repos.