dotfiles

A modern, flexible dotfiles configuration that works seamlessly across Bash, Zsh, and Fish shells. These dotfiles provide a consistent development environment regardless of which shell you prefer to use.

⚠️ These dotfiles are intended for my own environment. Use at your own risk.

Originally inspired by craftzdog, this repository has evolved to support a shell-agnostic approach to configuration.

Features

• Multi-shell compatibility: Works with Bash, Zsh, and Fish shells
• Shared configuration: Core settings are defined once and applied across all shells
• Modern development tools: Support for Neovim, tmux, git, and more
• Modular structure: Easy to understand, maintain, and customize
• Local customization: Simple way to add machine-specific configurations

Directory Structure

dotfiles/
├── .shell/                  # Shell-agnostic configurations
│   ├── aliases.sh           # Common aliases for all shells
│   ├── exports.sh           # Environment variables
│   ├── functions.sh         # Utility functions
│   └── path.sh              # PATH configuration
│
├── .config/                 # XDG config directory
│   └── fish/                # Fish shell configuration
│       ├── config.fish      # Main fish configuration
│       ├── config-macos.fish # macOS-specific fish settings
│       └── functions/       # Fish functions
│           ├── load_aliases.fish    # Loads shared aliases in fish
│           ├── load_functions.fish  # Implements shared functions in fish
│           └── source_shell_config.fish # Imports shared env vars
│
├── .bashrc                  # Bash configuration
├── .zshrc                   # Zsh configuration
├── .gitconfig               # Git configuration
├── .tmux.conf               # Tmux configuration
└── bootstrap.sh             # Installation script

How It Works

The core concept is simple: define configurations once and use them everywhere.

1. Shell-agnostic configs in .shell/ are written in POSIX shell syntax
2. Bash and Zsh source these files directly
3. Fish shell uses wrapper functions to convert these configs to fish syntax

This approach means you can switch between shells without losing your customizations or having to maintain multiple configurations.

Installation

Quick Start

1. Clone the repository:

   git clone https://github.com/dave6892/dotfiles.git
   cd dotfiles

2. Run the installation script:

   ./bootstrap.sh

   Or use the --force option to skip the confirmation prompt:

   ./bootstrap.sh --force

3. Apply the changes:

   • Restart your terminal, or
   • Source the configuration manually:

     # For bash
     source ~/.bashrc
     
     # For zsh
     source ~/.zshrc
     
     # For fish
     source ~/.config/fish/config.fish

What the Installation Does

The bootstrap.sh script will:

1. Create necessary directories (~/.shell, ~/.config/fish/functions)
2. Copy all configuration files to your home directory
3. Set correct permissions for executable files
4. Preserve your existing files (creates backups when needed)

Requirements

• Supported shells: Bash, Zsh, Fish
• Supported platforms: macOS, Linux
• Dependencies: rsync (usually pre-installed)

Usage

Available Aliases

Once installed, you'll have access to these aliases across all shells:

Navigation

..          # cd ..
...         # cd ../..
....        # cd ../../..
.....       # cd ../../../..

d           # cd ~/Documents
dl          # cd ~/Downloads
dt          # cd ~/Desktop
dev         # cd ~/Developer

Git Shortcuts

g           # git
gst         # git status
ga          # git add
grm         # git rm
gc          # git commit
gp          # git push
gl          # git pull
gd          # git diff
gb          # git branch
gco         # git checkout

System Utilities

h           # history
j           # jobs
week        # show current week number
timer       # simple timer utility

# Network
ip          # get external IP address
localip     # get local IP address
flush       # flush DNS cache

# File operations
c           # trim newlines and copy to clipboard
cleanup     # remove .DS_Store files recursively

macOS-Specific

show        # show hidden files in Finder
hide        # hide hidden files in Finder
showdesktop # show desktop icons
hidedesktop # hide desktop icons
spotoff     # disable Spotlight indexing
spoton      # enable Spotlight indexing

Available Functions

These functions work across all supported shells:

File Management

# Create directory and cd into it
mkd project-name

# Change to top-most Finder window location (macOS)
cdf

# Create compressed tar.gz archive
targz folder-name

# Extract various archive formats
extract archive.zip
extract archive.tar.gz
extract archive.rar
# ... supports many formats

Shell-Specific Features

Fish Shell

• Auto-completion: Enhanced tab completion for git, npm, and more
• Syntax highlighting: Real-time command syntax highlighting
• History: Intelligent command history with substring matching
• Functions: All shared functions are automatically converted to Fish syntax

Bash/Zsh

• History: Shared history configuration with sensible defaults
• Completion: Enhanced tab completion where available
• Prompt: Clean, informative prompt with git status

Environment Variables

The configuration sets up several useful environment variables:

• PATH: Optimized with common development tool paths
• EDITOR: Set to your preferred editor (neovim if available, vim otherwise)
• Development tools: Configured for various programming languages and tools

Using Different Shells

You can switch between shells at any time:

# Switch to bash
bash

# Switch to zsh
zsh

# Switch to fish
fish

# Change default shell (permanent)
chsh -s $(which fish)  # or bash, zsh

All your aliases and functions will work identically across shells.

Customization

Local Configurations

Add machine-specific settings without modifying the main configuration:

• Bash: Create ~/.bashrc.local
• Zsh: Create ~/.zshrc.local
• Fish: Create ~/.config/fish/config-local.fish

These files are automatically sourced if they exist.

Adding New Aliases or Functions

To add new aliases or functions that work across all shells:

1. Add them to the appropriate file in .shell/ directory
2. They'll be automatically loaded in all supported shells

Shell-Specific Customizations

For shell-specific features that can't be shared:

• Bash/Zsh: Add directly to .bashrc or .zshrc
• Fish: Add to ~/.config/fish/config.fish or create new functions in ~/.config/fish/functions/

Vim Setup

Requires Neovim (>= 0.5)

• vim-plug - A minimalist Vim plugin manager
• nvim-lspconfig - A collection of configurations for Neovim's built-in LSP
• nvim-treesitter - Treesitter configurations and abstraction layer for Neovim
• nvim-cmp - A completion plugin for neovim coded in Lua
• lspsaga.nvim - A light-weight LSP plugin based on Neovim built-in LSP with highly a performant UI
• nvim-lsp-installer - An LSP server installer
  • It is used for installing an LSP server for Tailwind CSS
• telescope.nvim - A highly extendable fuzzy finder over lists
• defx.nvim - A file explorer

Other Tools

Tmux Configuration

• Modern terminal multiplexer setup with sensible defaults
• Mouse support and improved key bindings
• Seamless navigation between tmux panes and vim splits

Git Configuration

• Useful aliases for common git operations
• Enhanced diff and log visualization
• Sensible defaults for better usability

Resources

• craftzdog or devaslife on YouTube: inspired the original environment setup.
• dev-setup: Check out my software setup suite. (Private for now).
• dev-setup is inspired by donnemartin's repo.

License

This project is licensed under MIT License - see the LICENSE file for details.