Skip to content

CLAUDE.md

Latest commit

 

History

History
36 lines (26 loc) · 2.04 KB

CLAUDE.md

File metadata and controls

36 lines (26 loc) · 2.04 KB

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

What This Is

A macOS dotfiles repo. Config files live in config/, rc files in rc/. The install.rb script symlinks everything into place.

Install Script

ruby install.rb        # symlinks + brew bundle + macOS defaults
ruby install.rb -n     # dry run — preview what would happen
ruby install.rb --no-brew --no-macos  # symlinks only

The script does four things:

  1. config/* → ~/.config/* (preserving directory structure)
  2. rc/* → ~/.<name> (adds dot prefix, e.g. rc/vimrc → ~/.vimrc)
  3. brew bundle — installs Homebrew packages (auto-detected when Brewfile exists, skip with --no-brew)
  4. macos.sh — applies macOS defaults (auto-detected on macOS, skip with --no-macos)

Files listed in SKIP (currently config.local.example) are excluded. Existing non-symlink files are backed up with .backup suffix.

Structure

  • config/fish/config.fish — Fish shell config: PATH, Homebrew, aliases (eza, bat, zoxide, fzf, rg), git/ruby abbreviations, Starship prompt
  • config/git/ — Git config with SSH signing, histogram diff, zdiff3 merge conflicts, rerere, auto-rebase on pull. Per-machine identity goes in ~/.config/git/config.local (see config.local.example)
  • config/vim/ — Modular vim config auto-sourced via glob in rc/vimrc. Files prefixed with _ (e.g. _plug.vim, _nvim-defaults.vim, _macvim.vim) are sourced explicitly and excluded from the glob
  • config/starship.toml — Single-line Starship prompt with Nerd Font symbols
  • config/mise/config.toml — Global mise settings (legacy version files, experimental features)

Conventions

  • Commit messages: short, imperative, title case (e.g. Add Pagination to Query Endpoint). No bullet-point bodies unless a single sentence of context is genuinely needed.
  • No test suite — this is a config-only repo.
  • Git config enforces signed commits (SSH), rebase on pull, and auto-setup of remote tracking.