dotfiles

My configuration files for bash, prompt styles, aliases, etc., managed with Chezmoi. Works on macOS and Linux.

Installation

Prerequisites

1. Install Chezmoi:

   # macOS
   brew install chezmoi
   
   # Linux (various methods)
   # Ubuntu/Debian: snap install chezmoi --classic
   # Arch: pacman -S chezmoi
   # Or install script: sh -c "$(curl -fsLS get.chezmoi.io)"

2. Install required tools (optional but recommended):

   # macOS
   brew install starship eza bat dust zoxide
   
   # Linux - use your package manager, e.g.:
   # Ubuntu: apt install bat zoxide
   # Arch: pacman -S starship eza bat dust zoxide
   # Or install via cargo: cargo install starship eza bat-fd dust zoxide

3. Note: ble.sh (for enhanced vim command line editing) will be automatically installed by Chezmoi setup scripts.

Setup

1. Initialize Chezmoi with this repository:

   chezmoi init https://github.com/WillJRoper/dotfiles.git

2. Preview what files will be managed:

   chezmoi diff

3. Apply the dotfiles:

   chezmoi apply

What's Included

• Shell Configuration: .aliases, .functions, .bash_profile, .bashrc
• Vim Command Line: Enhanced bash vi mode with ble.sh for vim keybindings on command line
• Starship: Custom prompt configuration with git integration
• WezTerm: Terminal emulator settings with Catppuccin theme
• Tmux: Terminal multiplexer with vim keybindings and plugins
• Neovim: Complete editor configuration
• Atuin: Shell history search configuration
• btop: Terminal system monitor preferences
• neofetch: System summary output preferences
• thefuck: Command correction settings
• GitHub CLI: Non-secret gh defaults and aliases
• OpenCode: Agent and MCP configuration
• Git: Global git configuration
• Scripts: Utility scripts including Python project cleanup

Neovim Documentation

• Main guide: home/dot_config/nvim/README.md
• Lua module map: home/dot_config/nvim/lua/README.md
• Core modules: home/dot_config/nvim/lua/core/README.md
• Plugin modules: home/dot_config/nvim/lua/plugins/README.md
• Utility modules: home/dot_config/nvim/lua/utils/README.md

Config Documentation

• XDG config overview: home/dot_config/README.md
• Starship: home/dot_config/starship/README.md
• Tmux: home/dot_config/tmux/README.md
• WezTerm: home/dot_config/wezterm/README.md
• Atuin: home/dot_config/atuin/README.md
• btop: home/dot_config/btop/README.md
• neofetch: home/dot_config/neofetch/README.md
• thefuck: home/dot_config/thefuck/README.md
• GitHub CLI: home/dot_config/gh/README.md
• OpenCode: home/dot_config/opencode/README.md

Chezmoi mapping reminder:

• home/dot_config/nvim in this repository is rendered to ~/.config/nvim on target machines.

Key Features

• Modern CLI tools integration (eza, bat, dust, zoxide)
• Comprehensive Git aliases
• Python environment management system
• Custom shell functions for development workflow
• Consistent theming across tools (Catppuccin)
• HPC-Aware: Automatically disables internet-dependent features (like Copilot) on HPC systems

Updating

To update your dotfiles:

chezmoi update

To make changes:

1. Edit files in your source directory: chezmoi cd
2. Add new files: chezmoi add ~/.config/newfile
3. Apply changes: chezmoi apply

Scripts

The included scripts are available system-wide:

• clean_py_project_install.sh - Cleans Python build artifacts (aliased as pip-clean)

HPC Environment Support

The configuration automatically detects HPC environments and disables internet-dependent features:

Detection Methods:

• Hostname patterns: cosma, login, compute, node, hpc
• Environment variables: SLURM_JOB_ID, PBS_JOBID, SGE_JOB_ID, SCHEDULER

Disabled on HPC:

• GitHub Copilot plugins (copilot.lua, copilot-chat.lua)
• Other internet-dependent features as needed

Manual Override: To force HPC mode on any system:

export SCHEDULER=slurm  # or any value
chezmoi apply

For more information about managing dotfiles with Chezmoi, see the Chezmoi documentation.