dotfiles

Personal configuration files for macOS and Linux (tested on Fedora Workstation).
Provides a simple, repeatable setup for shell, Git, Vim, and VS Code.

---

Features

• Shell Configuration

  • .zshenv for PATH/env — loaded by every shell, including non-interactive subshells (AI agents, scripts)
  • .zshrc for interactive setup — framework-free; plugins cloned directly into ~/.zsh/plugins
  • .bash_aliases with handy shortcuts (portable across macOS/Linux)
  • Portable open alias → open . on macOS, xdg-open . on Linux

• Git Configuration

  • git-config-setup.sh sets up:
    • identity (name/email)
    • sensible defaults (editor, rebase workflow, prune, autosquash)
    • aliases for common commands (co, c, st, hist, lg, …)
    • global ignore file (.DS_Store on macOS, space for Linux ignores too)
    • cross‑platform credential helper (macOS: osxkeychain; Linux: libsecret if available)

• Editor Configuration

  • .vimrc — minimal, no plugins: line numbers, search, indentation, system clipboard, persistent undo, jk→Esc
  • .vscode/settings.json for consistent VS Code behavior
  • .vscode/extensions.json listing recommended extensions
  • mcp.json for workspace/project metadata

• Setup Script

  • install.sh:
    • Safely symlinks dotfiles into your home directory
    • Backs up existing files as .bak before linking
    • Ensures Zsh plugins are installed/updated
    • Runs personal Git setup if git-config-setup.sh is present
    • Detects platform for VS Code settings path (macOS vs Linux)

---

Requirements

• macOS or Fedora/Linux
• Git
• Vim
• VS Code (with CLI code available in $PATH)
• Optional tools:
  • shfmt (shell formatter) for on-save formatting in VS Code — install via brew install shfmt (macOS) or sudo dnf install shfmt (Fedora)
  • fzf for vf/cf aliases

---

Usage

1. Clone this repository:

   git clone https://github.com/benrozsa/dotfiles.git ~/Dev/dotfiles
   cd ~/Dev/dotfiles

2. Install (symlink + backups):

   ./install.sh

   This links your dotfiles, sets up VS Code user settings, and clones the Zsh plugins into ~/.zsh/plugins.

3. Git setup: Already run by ./install.sh when git-config-setup.sh is present.

   • Re-run manually any time with: ./git-config-setup.sh
   • macOS uses Keychain; Linux uses libsecret when available.
   • Security note (Linux): if libsecret isn't installed, credentials won't be stored. Install git-credential-libsecret (e.g., sudo dnf install git-credential-libsecret on Fedora) or build from Git's contrib if needed.

4. VS Code: Open the repo and install the recommended extensions. Formatting uses shfmt from your PATH. Ensure it’s installed (e.g., brew install shfmt on macOS or sudo dnf install shfmt on Fedora).

5. Extras: fzf enables vf/cf helpers. See .bash_aliases for more.

More implementation details are in CONTRIBUTING.md.

---

Reverting

• The installer backs up any replaced files with a .bak suffix in your home directory. To revert, remove the symlink and restore from the matching .bak file.