Skip to content

README.md

Latest commit

 

History

History
95 lines (65 loc) · 4.74 KB

README.md

File metadata and controls

95 lines (65 loc) · 4.74 KB

Dotfiles

Manage dotfiles using chezmoi.

Installation

Use one of the one-liner below to install both chezmoi and the dotfiles.

One-liners

sh & curl

sh -c "$(curl -fsLS get.chezmoi.io/lb)" -- init --apply sakakibara

sh & wget

sh -c "$(wget -qO- get.chezmoi.io/lb)" -- init --apply sakakibara

powershell

'$params = "-BinDir ~/.local/bin -ExecArgs init, --apply, sakakibara"', (irm -useb https://get.chezmoi.io/ps1) | powershell -c -

After install

chezmoi apply runs a set of per-step run_once_ scripts after the file deploy. Each is hash-triggered against its own inputs — the brew script re-fires when etc/darwin/packages.txt, the blacklist, or the bash libraries it sources change; the mise script when its config template changes; and so on:

  • install-1-brew.sh.tmpl (macOS) / install-1-linux-packages.sh.tmpl (Linux): native package install via etc/darwin/packages.txt or etc/linux/packages-*.txt (auto-detects fedora/debian/arch/suse).
  • install-2-mise.sh.tmpl: language toolchains via mise.
  • install-3-extras.sh.tmpl (Linux): bucket-3 tools not in distro repos (starship, gh, lazygit, lazydocker, cargo-installed Rust tools).
  • install-4-hive.sh.tmpl: workspace symlink layout via hive.
  • run_once_setup-theme.sh.tmpl (macOS / Linux / WSL) and the windows/ PowerShell counterpart: downloads theme assets referenced by manifests under ~/.config/dotfiles/themes/, verifies their sha256, and seeds ~/.local/state/dotfiles/theme with the manifest's default. After this, theme set <family>/<variant> switches everything (kitty, wezterm, tmux, nvim, fish colors, fzf, vivid) at once.

On Windows native, chezmoi apply runs the PowerShell counterparts under .chezmoiscripts/windows/: run_once_install-1-scoop.ps1.tmpl (scoop + winget package install via etc/windows/packages.txt), run_once_install-2-mise.ps1.tmpl (mise toolchains), run_once_install-4-hive.ps1.tmpl (workspace symlinks via hive), and run_once_setup-theme.ps1.tmpl (theme assets). The wrapper-level dotfiles command on Windows is dot_local/bin/dotfiles.ps1; sync and the rest of the subcommands work the same as the bash side.

The dotfiles wrapper

The dotfiles command sits in front of chezmoi and adds the steps chezmoi doesn't cover natively. Anything it doesn't recognize is forwarded to chezmoi (with a typo-aware error if the subcommand isn't valid for chezmoi either).

dotfiles                          # status snapshot — repo, branch, drift, theme, tools
dotfiles info                     # same as bare invocation

# Install / package management
dotfiles install                  # menu (pre-checks items whose hash changed)
dotfiles install all              # run every step non-interactively
dotfiles install brew mise        # run only the named steps
dotfiles sync                     # review installed-but-untracked packages

# Editing
dotfiles edit <pattern>           # fuzzy-find a managed file and open it via chezmoi edit

# Profile / health
dotfiles profile                  # print the active chezmoi profile
dotfiles profile work             # switch profile and re-apply
dotfiles doctor                   # health-check chezmoi, packages, theme, mise, hive

# Upgrades
dotfiles upgrade                  # chezmoi binary self-update
dotfiles upgrade --all            # chezmoi + sources + brew (macOS) + mise + hive
                                  # (Linux distro packages are skipped — run `sudo dnf upgrade` / `apt upgrade` manually)

Per-step install output lands in ~/.local/state/dotfiles/pick/logs/; a TSV run history lives at ~/.local/state/dotfiles/pick/run-log.tsv.

Daily edit gesture: dotfiles edit <pattern> (or chezmoi edit <path> directly) — both open the source template, save-applies, no drift round-trip. When something OTHER than your editor (an app, the OS) writes into a managed file, run chezmoi re-add <path> to capture the drift back into source.

Theme system

Switch theme:

theme catppuccin/frappe         # explicit family/variant
theme set frappe                # within current family
theme reload                    # re-fire reload signals without state change
theme list                      # discover families
theme list catppuccin           # discover variants

Manage assets:

theme install                   # download missing
theme refresh                   # force re-download, update lockfile
theme verify                    # check cache against lockfile

Add a new theme family: drop a manifest at ~/.config/dotfiles/themes/<family> (flat key=value, see dot_config/dotfiles/themes/catppuccin for the shape) and run theme refresh <family> to populate the lockfile.