peinan's dotfiles

A collection of configuration files for setting up a development environment on macOS.

Quick Start

WARNING

This dotfiles is designed for macOS only.

# One-liner install (recommended)
curl -fsSL https://dotfiles.peinan.cc/install | bash

# or via GitHub
curl -fsSL https://raw.githubusercontent.com/peinan/dotfiles/HEAD/scripts/install.sh | bash

For manual installation, see the installation page.

What's Included

• Shell: Zsh (.zshrc, .zshenv, .alias)
  • Prompt: Starship
  • Plugin Manager: Sheldon
• Git: Git configuration (.config/git/config) and delta for beautiful diffs
• Editors: Neovim (standalone repository)
• Terminal: Ghostty
• Multiplexing: tmux (standalone repository)
• Package Management: Homebrew (Brewfile)
• Font: Kusunoki Mono

Repository Structure

This repository uses GNU Stow to manage symlinks. All configuration files are located in the src/ directory:

dotfiles/
├── src/                <-- Maps to $HOME
│   ├── .zshrc          <-- Links to ~/.zshrc
│   └── .config/        <-- Links to ~/.config/
│       ├── git/        <-- Links to ~/.config/git
│       ├── ghostty/    <-- Links to ~/.config/ghostty
│       └── starship/   <-- Links to ~/.config/starship
├── misc/               <-- GUI app exports & templates (Not stowed)
├── scripts/            <-- Setup scripts (Not stowed)
└── Brewfile            <-- Homebrew bundle (Not stowed)

Everything under src/ is linked; anything that should not be belongs outside it. Values that cannot go in a public repository live in a separate private one — see Config Repositories.