My Dotfiles

This repository contains my personal dotfiles for various applications.

Demo

Interactive setup demonstration showing the TUI-based installation process

Quick Start

Launch the interactive dotfiles manager:

df                # Quick access
dotfiles          # Full command

Run dotfiles --help or df --help for complete usage guide.

Interactive Setup

cd ~/.config/dotfiles/setup
bun run setup     # Full interactive TUI

bun run cli       # Non-interactive (headless) mode

Command Line Arguments

The setup script supports various command-line arguments for fine-grained control:

Argument	Description
--dry-run	Preview all installations without making changes
--dry-run-section <NAME>	Preview a specific section only
--dry-run-interactive	Interactive dry-run mode (alias: --dry-run-i)
--skip-system-update	Skip apt update/upgrade step
--skip-fonts	Skip Nerd Fonts installation
--verbose, -v	Show detailed installation output
--quiet, -q	Minimal output, errors only
--install <NAME>	Install a specific section non-interactively
--install-interactive	Select sections to install interactively (alias: --install-i)
--skip <NAME>	Skip a specific section during installation
--skip-interactive	Select sections to skip interactively (alias: --skip-i)
--list	List all available packages by category
--all, --yes, -y	Non-interactive mode. Installs all categories without prompts

Examples:

# Preview what would be installed
bun run setup --dry-run

# Install everything without prompts
bun run setup --all --skip-fonts

# Install only essential packages
bun run setup --install essential --verbose

# Preview specific category
bun run setup --dry-run-section cli-utils

Note: Generate the demo GIF by running ./scripts/generate-demo-gif.sh (requires terminalizer or asciinema + agg)

Structure

The repository is structured as follows:

• bin/: Executable scripts and tools (globally available)
• configs/fish/: Fish shell configuration
  • aliases/: Shell aliases organized by category
  • functions/: Custom Fish functions
• scripts/: Utility scripts and tools
• env-private/: Private environment variables (see Private Files Guide)

Private Files & Secrets

This repository is open source, but some files contain sensitive information and are kept private:

• Private environment variables are stored in env-private/ (gitignored or as git submodule)
• User-specific data is stored in $HOME/.dotfiles/ (outside the repository)
• Secrets and API keys are never committed to the repository

See docs/PRIVATE-FILES.md for a complete guide on:

• How to handle private files and secrets
• Best practices for open source dotfiles
• Setting up private configuration
• Security checklist

Installation

Fresh Machine Setup (Bootstrap)

For a completely fresh machine, use the bootstrap script to handle initial setup.

Prerequisites (Required Before Running):

1. ✅ Internet connection - To download repositories and tools
2. ✅ GitHub authentication - For the private env-private repository:
   • Recommended: Install GitHub CLI and authenticate:

     # Install gh (Ubuntu/Debian)
     curl -fsSL https://cli.github.com/packages/githubcli-archive-keyring.gpg | sudo dd of=/usr/share/keyrings/githubcli-archive-keyring.gpg
     echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/githubcli-archive-keyring.gpg] https://cli.github.com/packages stable main" | sudo tee /etc/apt/sources.list.d/github-cli.list > /dev/null
     sudo apt update && sudo apt install gh -y
     gh auth login

   • Alternative: Use a Personal Access Token (you'll be prompted during clone)
     • Create one at: https://github.com/settings/tokens
     • Use it as the password when prompted (username is your GitHub username)

Note: The main dotfiles repository is public and requires no authentication. Only env-private needs authentication.

curl -fsSL https://raw.githubusercontent.com/remcostoeten/dotfiles/main/bootstrap.sh | bash

Or download and run manually:

curl -fsSL https://raw.githubusercontent.com/remcostoeten/dotfiles/main/bootstrap.sh -o /tmp/bootstrap.sh
chmod +x /tmp/bootstrap.sh
bash /tmp/bootstrap.sh

What the bootstrap script does:

1. ✅ Checks prerequisites (internet, GitHub auth)
2. ✅ Installs Git (if needed)
3. ✅ Clones the dotfiles repository to ~/.config/dotfiles
4. ✅ Initializes git submodules (env-private, nvim config, etc.)
5. ✅ Restores SSH keys from env-private/.ssh/ to ~/.ssh/
6. ✅ Installs essential tools (Bun runtime)
7. ✅ Makes all scripts executable
8. ✅ Prompts to run the main setup script

See Bootstrap Guide for detailed troubleshooting and alternative authentication methods.

Quick Setup (If dotfiles already cloned)

1. Clone this repository:

git clone https://github.com/remcostoeten/dotfiles ~/.config/dotfiles

2. Run the setup script:

cd ~/.config/dotfiles/setup;
bun install;
bun run setup

The setup script will:

• Install all required dependencies (fish, bun, fzf, starship, etc.)
• Create necessary symlinks
• Set up PATH variables
• Configure fish shell

Manual Installation

If you prefer manual setup:

# Clone repository
git clone <your-repo-url> ~/.config/dotfiles

# Symlink fish config
ln -s ~/.config/dotfiles/cfg ~/.config/fish/config.fish

# Add to PATH (add to ~/.bashrc or ~/.zshrc)
export PATH="$HOME/.config/dotfiles/bin:$PATH"
export PATH="$HOME/.config/dotfiles/scripts:$PATH"