⚙ Dotfiles

These are the base dotfiles that I start with when I set up a new environment. They are stored in this repository for convenience and are broken down into macOS, Linux, and Windows sections for easy access and installation.

🔧 Repository Structure

dotfiles/
├── install.ps1       # Windows installation script
├── install.sh        # Linux installation script
├── install.zsh       # macOS installation script
├── install-min.zsh   # Minimal macOS installation script
├── starship.toml     # Cross-platform Starship prompt configuration
├── Nix/              # Shared Unix configurations
│   ├── .zshrc        # ZSH configuration file
│   ├── .zsh_plugins.txt # Antidote plugin definitions
│   ├── bin/          # Custom scripts and utilities
│   └── functions/    # ZSH function definitions
└── Windows/          # Windows-specific configurations
    ├── Microsoft.PowerShell_profile.ps1   # PowerShell profile
    ├── Terminal/     # Windows Terminal settings
    ├── winget/       # Windows Package Manager settings
    └── ...

🍎 macOS

This repository contains a straightforward installation script (install.zsh) for setting up a new macOS environment according to my preferred configurations.

Features

• Package Managers: Installs and configures Homebrew with various formulae, casks, and fonts. Also configures npm for JavaScript packages.
• Applications: Installs essential applications via Homebrew casks and Mac App Store (using mas).
• Shell Environment:
  • Uses Antidote for plugin management (replacing Oh-My-Zsh)
  • Installs customized ZSH plugins including:
    • zsh-history-substring-search
    • fast-syntax-highlighting
    • zsh-autosuggestions
    • zsh-autocomplete
    • zsh-z
    • zsh-you-should-use
    • fzf shell extensions
  • Configures Starship prompt for beautiful, informative terminal
• Configuration Files: Replaces the current .zshrc file with my custom configuration.
• Binary Scripts: Installs various custom utilities and tools to ~/bin/.
• iCloud Integration: Creates symbolic links to iCloud Drive folders.
• Git Configuration: Sets up git with personalized configurations.

Installation

$ git clone https://github.com/AnalogCyan/dotfiles.git ~/dotfiles
$ cd ~/dotfiles
$ chmod +x install.zsh
$ ./install.zsh

After installation completes, you'll be prompted to restart your terminal to see the changes.

🐧 Linux & Homelab Server

This repository includes an installation script (install.sh) for setting up a new Linux environment on Debian-based distributions, with optional homelab server configurations.

Features

• System Compatibility: Ensures the script runs only on compatible Debian-based systems.
• System Updates: Updates system packages and fixes any broken installations.
• Software Installation: Installs essential packages:
  • Development tools (gcc, g++, git)
  • System utilities (vim, htop, screen)
  • Shell enhancements (zsh, fortune, mosh)
  • Media tools (ffmpeg, mpv, yt-dlp)
  • Additional utilities (bat, fzf, thefuck, etc.)
• Shell Environment:
  • Changes default shell to zsh
  • Uses Antidote for plugin management
  • Installs the Starship prompt for a consistent cross-platform experience
• Configuration Files: Installs custom zsh configurations and functions.
• Server-Specific Features: When set up as a server, additionally installs:
  • iTerm2 shell integration
  • NextDNS
  • Plex Media Server
  • Docker with proper configuration
• Binary Scripts: Installs pfetch and other custom utilities to ~/bin/.
• Git Configuration: Sets up git with personalized settings.
• 1Password CLI: Installs and configures the 1Password command-line interface.
• PowerShell: Installs Microsoft PowerShell for cross-platform consistency.

Installation

$ git clone https://github.com/AnalogCyan/dotfiles.git ~/dotfiles
$ cd ~/dotfiles
$ chmod +x install.sh
$ ./install.sh

During installation, you'll be asked if you're setting up a server environment. Based on your response, additional configurations will be applied.

🪟 Windows

The Windows installation script (install.ps1) provides comprehensive setup for Windows 10 and 11 environments.

Features

• System Configuration: Ensures compatibility with Windows 11.
• Sudo Support: Configures built-in Windows sudo functionality when available or installs gsudo as fallback.
• System Updates: Ensures Windows is up-to-date using PowerShell modules.
• Package Managers: Installs and configures Windows Package Manager (winget).
• Applications: Installs a wide range of applications using winget:
  • Development tools (Git, VSCode, Python, etc.)
  • System utilities (PowerToys, Terminal, NanaZip, etc.)
  • Nerd Fonts for enhanced terminal experience
• PowerShell Environment: Installs and configures:
  • Starship prompt (replacing Oh-My-Posh)
  • Terminal-Icons
  • PSReadLine
• Configuration Files: Installs custom configurations for:
  • PowerShell profile
  • Windows Terminal
  • Winget settings
• Git Configuration: Configures git with personalized settings.

Installation

# Clone the repository
git clone https://github.com/AnalogCyan/dotfiles.git ~\dotfiles
cd ~\dotfiles
# Run the installation script (requires non-admin PowerShell)
.\install.ps1

After installation completes, you'll be prompted to restart your computer to apply all changes.

🌟 Key Components

Starship Prompt

This repository uses Starship, a minimal, blazing-fast, and infinitely customizable cross-platform prompt. The starship.toml configuration provides:

• Customized prompt symbol (dot) with color-coding for success/failure
• Git branch and status information displayed on the right
• Directory path display with customizable truncation
• Special indicators for SSH sessions
• Vim mode indicators
• Python environment detection

Antidote Plugin Manager

The repository uses Antidote, a fast and flexible plugin manager for ZSH:

• Simpler, cleaner plugin management
• Faster shell startup time
• All plugins defined in a single .zsh_plugins.txt file
• Support for modern ZSH plugins and functionality

⚠️ Important Notes

• Always review the scripts before running them to ensure they match your needs.
• Replace the git configuration with your own information (GIT_USER_NAME and GIT_USER_EMAIL variables).
• Some applications may require additional manual setup after installation.
• These scripts are designed for personal use and may need adjustment for your specific environment.

🔄 Updates and Maintenance

These dotfiles are regularly updated as my workflow evolves. To update your existing installation:

# Navigate to your dotfiles directory
cd ~/dotfiles
# Pull the latest changes
git pull
# Run the appropriate installation script for your OS
# macOS:
./install.zsh
# Linux:
./install.sh
# Windows:
./install.ps1