.dotfiles

Guides

Install

Set up on macOS, Linux, or WSL in 3 to 5 minutes.

You will need: git and curl.

Default shell: Fish. You can change it after you install.

Install

Download and SHA256-verify the release-pinned installer using the canonical command in the root README, then:

bash /tmp/dotfiles-install.sh

Then restart your terminal or run exec $SHELL.

Verify

dot --version        # Confirm installation
dot doctor           # Check shell, git, and tools
dot help             # Browse available commands

Choose a shell

Fish is the default shell. To switch to Zsh or Nushell, edit ~/.dotfiles/.chezmoidata.toml:

default_shell = "zsh"

Supported values: zsh, fish, nushell.

Then apply the change:

dot apply

Feature flags

Turn optional tools on or off after setup. Edit .chezmoidata.toml:

[features]
zsh = true         # Zsh shell configuration
fish = true        # Fish shell configuration
nushell = true     # Nushell configuration
nvim = true        # Neovim IDE configuration
tmux = true        # Terminal multiplexer
nix = true         # Nix package manager integration

Update

dot update

Next steps

  1. Run dot learn to take a guided tour.
  2. Add your own tweaks in ~/.config/shell/custom/.
  3. Read the Utilities and dot CLI reference.

Advanced

Local source install

Clone the repo first, then run the installer from your local copy:

git clone https://github.com/sebastienrousseau/dotfiles.git ~/.dotfiles
cd ~/.dotfiles
./install.sh

Minimal install

Install only shells and core tools. This selects the minimal profile in this host's ~/.config/chezmoi/chezmoi.toml (the tracked source is not edited) and skips toolchain provisioning:

./install.sh --minimal

Non-interactive install

Use this mode for CI or scripts that run without user input:

# After the verified download above:
DOTFILES_SILENT=1 DOTFILES_NONINTERACTIVE=1 \
  bash /tmp/dotfiles-install.sh --force

Nix

nix develop ~/.dotfiles/nix
nix profile install ~/.dotfiles/nix#dot-utils

Offline bundle

On a machine with internet access, create a bundle:

dot bundle ~/Downloads

Copy the archive to the target machine. Then unpack and install:

tar --zstd -xf dotfiles_offline_bundle_*.tar.zst -P
cd ~/.dotfiles
./install.sh --force

Uninstall

chezmoi purge
rm -rf ~/.dotfiles
rm -rf ~/.local/share/chezmoi ~/.local/share/dotfiles.log

Signed contributions

All commits must be signed. See Contributing for details.