A single, automated dotfiles repo for macOS, Linux, and Windows — Neovim, Zsh/PowerShell, Tmux, Git, and a modern CLI toolchain, managed with GNU Stow on Unix and native symlinks on Windows. Clone it, run one command, get the same environment everywhere.
Warning: These dotfiles are personalized and will overwrite existing configurations. Fork the repo and review the scripts before running on your machine.
Real recording of this repo's actual setup — the startup banner, eza-powered
listings, the custom dutils CLI, and Neovim, captured with
VHS.
- What's Included
- Quick Start
- How It Works
- Uninstall
- Repository Structure
- Documentation
- Resources
- License
| Zsh | Modular config via conf.d/, Zinit plugin manager, Starship prompt (Powerlevel10k available), television fuzzy finder |
| Neovim | Lazy.nvim, LSP, Treesitter, Telescope, autocompletions |
| Git | 40+ aliases, delta diff viewer, XDG-compliant config |
| Tmux | TPM plugin manager, vim-aware pane switching, session persistence |
dutils |
One CLI for cleanup, updates, SSH keygen, OS detection, interactive diffing, and more |
| CLI tools | macOS via Homebrew (brew/Brewfile); Linux via Nix + Home Manager (nix/, replaces linuxbrew) — eza, bat, ripgrep, fd, zoxide, and more. See docs/NIX.md |
Two prompts ship here: Starship (default) and Powerlevel10k. The choice is
a single knob, DOTFILES_PROMPT, read at the top of zsh/.config/zsh/.zshrc.
Both stay fully wired — switching never removes anything.
Try one for a single session (nothing permanent):
DOTFILES_PROMPT=p10k exec zsh # switch to Powerlevel10k
DOTFILES_PROMPT=starship exec zsh # switch to StarshipMake it permanent — set it as an environment variable so it's defined before
.zshrc runs. Put it in ~/.zshenv (or edit the default on the
: "${DOTFILES_PROMPT:=starship}" line at the top of .zshrc):
echo 'export DOTFILES_PROMPT=p10k' >> ~/.zshenv # or =starship
exec zshNote:
DOTFILES_PROMPTmust be set before.zshrcloads, so~/.zshenvor your environment works — butconf.d/99-private.zshdoes not (it's sourced after the prompt is already up).
Starship's config is starship/.config/starship/starship.toml; Powerlevel10k's
is zsh/.config/zsh/.p10k.zsh (regenerate with p10k configure).
bash -c "$(curl -fsSL https://raw.githubusercontent.com/itsmeakashgoyal/dotfiles/master/bootstrap.sh)"git clone https://github.com/itsmeakashgoyal/dotfiles.git ~/dotfiles
cd ~/dotfiles
make install dry=1 # preview every action, change nothing
make install # apply
exec zshFor prerequisites, platform-specific notes, and what the installer does, see Installation Guide.
Prerequisites: PowerShell 5.1+ (built-in) or PowerShell 7+. No other tools needed — the script installs everything.
Option A — fresh machine (run in PowerShell):
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
irm https://raw.githubusercontent.com/itsmeakashgoyal/dotfiles/master/windows/install.ps1 | iexOption B — already cloned:
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
cd ~\dotfiles
.\windows\install.ps1What it installs automatically:
| Step | What happens |
|---|---|
| Scoop | Package manager bootstrapped if missing |
| CLI tools | ripgrep, television, atuin, bat, eza, fd, zoxide, neovim, lazygit, delta, … |
| PS modules | PSReadLine, Terminal-Icons |
| Symlinks | PowerShell profile, nvim, git, tmux, television, atuin, fastfetch |
| Neovim | Config linked; lazy.nvim bootstraps on first nvim launch |
Symlinks require either Administrator privileges or Developer Mode enabled (
Settings → System → For Developers).
PowerShell profile features
| Shortcut / Alias | What it does |
|---|---|
Ctrl+T |
television (tv) smart autocomplete — context-aware: files/dirs/branches |
Ctrl+R |
atuin history search |
Alt+C |
tv cd into directory |
Tab |
after a space: tv smart autocomplete; mid-word: native completion |
ls / ll / la / lt |
eza with icons and git status |
cat |
bat with syntax highlighting |
grep |
ripgrep (rg) |
find |
fd |
z <dir> |
zoxide smart jump |
rm -rf <path> |
recursive force delete |
rmdir <dir> |
remove directory (with -p for empty parents) |
touch / mkcd |
create file / mkdir + cd |
gs / gc / gp / glog |
git shortcuts |
gco / gcr / gbd |
fuzzy checkout local/remote branch, fuzzy delete (plain args still work) |
gpr / gct |
fuzzy checkout PR (gh) / tag |
logg |
interactive git log with tv, opens selected commit in nvim |
rgf |
ripgrep → tv → open in editor |
Every top-level directory (git/, zsh/, nvim/, tmux/, …) is a Stow package. Each package
mirrors the target path relative to $HOME:
Running stow <package> from the repo root creates the correct symlinks automatically. Edits in the
repo take effect immediately — no re-linking needed.
To remove the dotfiles setup from your machine, run from the repo root:
cd ~/dotfiles
make uninstallAfter one confirmation, it gracefully and completely reverses the install:
- Restores your login shell to the OS default (
/bin/zshon macOS,/bin/bashon Linux) - Removes all dotfile symlinks (unstows every package) and sweeps any leftovers
- Clears generated caches (zsh compdump, stow backups)
- Uninstalls Nix if present — removes Home Manager packages first, then Nix itself
- Uninstalls Homebrew if present — removes all its packages first, then brew itself
⚠️ This is a complete removal. Both package managers are uninstalled entirely, including any packages you installed outside these dotfiles. Your repo, shell history, and personal data (~/.ssh, git config, etc.) are left untouched.
Preview first (recommended) — shows every action without changing anything:
make uninstall dry=1Skip the confirmation prompt (e.g. for scripts/CI):
make uninstall force=1The repo itself is left on disk — delete it manually if you want it gone:
rm -rf ~/dotfilesSee docs/NIX.md for Nix-specific removal notes.
Windows has no make/Stow, so windows.ps1 has its own -Uninstall mode
instead — removes every symlink it created, its PATH entry, generated Neovim
data, the PowerShell modules it installed, and reverts the Windows Terminal
theme (from the backup it made before touching it):
.\windows\windows.ps1 -Uninstall
.\windows\windows.ps1 -Uninstall -DryRun # preview first
.\windows\windows.ps1 -Uninstall -Force # skip the confirmation promptScoop packages this script installed are removed too by default; Scoop itself
is left alone unless you also pass -PurgeScoop (opt-in — Scoop is a general
package manager, more likely to be used for things outside these dotfiles than
Homebrew/Nix typically are). dutils cleanup dotfiles runs a narrower
-SymlinksOnly version of this on Windows — just the symlinks/PATH entry,
matching that component's own scope. See docs/WINDOWS.md
for details.
dotfiles/
├── git/ → ~/.config/git/ Git config & aliases
├── zsh/ → ~/.config/zsh/ Zsh shell configuration
├── nvim/ → ~/.config/nvim/ Neovim editor setup
├── tmux/ → ~/.config/tmux/ Tmux multiplexer
├── packages.toml THE package manifest — every tool, every platform
├── brew/ Brewfile — generated from packages.toml (macOS)
├── nix/ Home Manager flake — Linux packages (replaces linuxbrew)
├── scripts/ Setup, verification, and the dutils CLI
├── settings/ App preferences (iTerm, Sublime)
├── windows/ Everything Windows-only: installer, setup script,
│ PowerShell profile, Windows Terminal theme
├── docs/ Guides + this README's banner/demo assets
├── install.sh Main installer (macOS/Linux)
├── bootstrap.sh One-liner bootstrap for fresh machines
└── Makefile Stow management & diagnostics
packages.toml is the single source of truth for every tool this repo installs and
every Stow package it links. The per-manager lists are generated from it:
| Generated region | File |
|---|---|
| Homebrew formulae & casks | brew/Brewfile |
| Nix packages | nix/home.nix |
| Scoop apps + Windows symlink map | windows/windows.ps1 |
| apt bootstrap deps | scripts/setup/linux.sh |
STOW_PACKAGES |
Makefile |
# add or edit a [[package]] entry in packages.toml, then:
make manifest # regenerate every list (alias: dutils manifest generate)
make manifest-check # fail if a list drifted (runs in CI)
dutils manifest list # show what gets installed on each platformThe health checks read the same file, so dutils health / dutils check never drift from what's
actually declared. Only the text between the BEGIN GENERATED / END GENERATED markers is
rewritten — everything else in those files stays hand-written.
| Document | Description |
|---|---|
| Installation | Prerequisites, platform notes, what the installer does |
| Usage | Makefile commands, updating, adding packages, diagnostics |
| Nix (Linux) | Nix + Home Manager package management on Linux (replaces linuxbrew) |
| Python | mise (interpreter versions) + uv (venvs, packages, lockfiles) |
| Windows | Config toggles (native prompt, mise activation), troubleshooting (OneDrive profile path, slow startup, large-repo git perf) |
| SSH & Git identity | Personal + work SSH keys (dutils ssh-setup), per-repo commit identity, cross-platform |
| Secrets | Encrypted secrets in the repo via age + your SSH key (dutils secrets) |
| Theming | Coordinated Tokyo Night across ghostty/bat/fzf/delta/nvim with a light/dark switch (dutils theme) |
| Sublime Text | Cross-platform Sublime IDE — LSP (C/C++/Python), Terminus, builds, Tokyo Night; symlinked settings |
| OSXPhotos | Backing up the macOS Photos library (originals, edits, Live Photos) by month |
| organize-media | Sorting an already-exported flat photo/video backup folder (no Photos library involved) into year/month folders (dutils organize-media) |
| Customization | Personalizing Git, Zsh, Neovim, Tmux configs |
| Troubleshooting | Common issues, debug workflow, uninstalling |
| Architecture | Deep dive: Stow internals, Zsh flow, scripts, CI, XDG |
| Contributing | How to contribute, code style, PR process |
| Security | Secrets management and security practices |
- GNU Stow -- Symlink farm manager
- Homebrew -- Package manager for macOS and Linux
- Neovim -- Hyperextensible text editor
- Starship -- Zsh prompt used by default here (Powerlevel10k is available as an alternative — see Switching prompts)
- VHS -- Terminal demo recorder (used for the preview above)
- Awesome Dotfiles -- Community dotfiles resources
BSD 2-Clause License. See LICENSE for details.
Akash Goyal — @itsmeakashgoyal
