https://github.com/cebor/dotfiles
Cebor's macOS dotfiles
https://github.com/cebor/dotfiles
brew dotfiles macos
Last synced: 3 months ago
JSON representation
Cebor's macOS dotfiles
- Host: GitHub
- URL: https://github.com/cebor/dotfiles
- Owner: cebor
- License: mit
- Created: 2014-02-21T11:56:44.000Z (over 12 years ago)
- Default Branch: main
- Last Pushed: 2025-11-28T13:15:58.000Z (7 months ago)
- Last Synced: 2025-11-30T18:10:18.761Z (7 months ago)
- Topics: brew, dotfiles, macos
- Language: Shell
- Homepage:
- Size: 379 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Dotfiles
Personal macOS configuration and dotfiles management system.
## Quick Start
### First-Time Setup
```bash
git clone ~/.dotfiles
cd ~/.dotfiles
./install.sh # Automatically runs bootstrap if needed, then installs everything
exec zsh # Reload shell
```
### Regular Updates
```bash
./install.sh # Safe to re-run - updates packages and syncs dotfiles
# Or for quick dotfile-only syncs:
./sync.sh -f # Sync dotfiles without package updates
```
## What's Included
### Shell Configuration
- **Zsh** with [antidote](https://getantidote.github.io/) plugin manager
- **Starship** prompt
- Oh My Zsh plugins (git, brew, extract)
- Enhanced utilities (zsh-autosuggestions, zsh-syntax-highlighting, z)
### Applications (via Homebrew)
- Development: helix, vim, git, python, node, docker
- Networking: httpie, nmap, mtr, wrk
- Kubernetes: kubectl, helm, yq
- GUI apps: iTerm2, VS Code, Firefox, Obsidian, and more
See [`Brewfile`](Brewfile) for the complete list.
### Custom Functions & Aliases
**Smart Python venv activation:**
```bash
svenv # Finds and activates venv/.venv/poetry/pipenv in parent directories
```
**File sharing:**
```bash
scpp file.txt # Upload to stkn.org and copy URL to clipboard
```
**Utilities:**
```bash
server 8080 # Start HTTP server on port 8080
tunnel host 3306 3307 # SSH port forwarding
pwgen 20 # Generate 20-character password
```
See [`.aliases`](system/.aliases) and [`.functions`](system/.functions) for all shortcuts.
## Scripts
| Script | Purpose | When to Use |
|--------|---------|-------------|
| `bootstrap.sh` | One-time system setup (Xcode CLI tools, Homebrew) | First installation only (or run automatically by install.sh) |
| `install.sh` | Full installation - auto-runs bootstrap if needed, installs/updates packages, sets brewed zsh as default shell | First-time setup AND regular updates (safe to re-run) |
| `sync.sh` | Sync dotfiles only (supports `-f`, `-d` flags) | Quick dotfile-only syncs or testing changes |
| `git.sh` | Apply git config settings, prompts for user.name/email if not set | Called by install.sh |
### Script Flags
```bash
./sync.sh -d # Dry-run: preview changes without syncing
./sync.sh -f # Force: skip confirmation prompt
```
## Project Structure
```
dotfiles/
├── git/ # Git-specific config (.gitignore_global, .gitattributes_global)
├── system/ # Shell and app dotfiles (.zshrc, .vimrc, .tmux.conf, etc.)
├── *.sh # Setup and maintenance scripts
├── Brewfile # Homebrew package definitions
└── .github/ # AI agent instructions
```
Files in `git/` and `system/` are synced to `$HOME` via rsync.
## Customization
1. **Add a package**: Edit `Brewfile` → run `brew bundle` or `./install.sh`
2. **Add an alias**: Edit `system/.aliases` → run `./sync.sh -f` → reload shell
3. **Add a zsh plugin**: Edit `system/.zsh_plugins.txt` → run `./sync.sh -f` → reload shell
4. **Modify macOS settings**: Edit `macos.sh` → run `./macos.sh` → restart affected app
## Configuration Highlights
### Git
- Default editor: **helix** (`hx`)
- Default branch: `main`
- Credentials stored in macOS keychain
### Vim
- Plugin manager: vim-plug
- Theme: Solarized Dark
- Persistent undo, automatic position restore
### macOS
- Finder: show path bar, status bar, all extensions
- Dock: minimize to application, auto-hide
- Trackpad: tap to click enabled
See [`macos.sh`](macos.sh) for all system preferences.
## Maintenance
### Preview Changes
```bash
./sync.sh -d # See what would change without applying
```
### Update Everything
```bash
./install.sh # Syncs dotfiles, updates packages, reconfigures git/vim/macOS
```
## Requirements
- macOS (tested on recent versions)
- Xcode Command Line Tools (installed by `bootstrap.sh`)
- Internet connection for initial setup
## License
MIT - See [LICENSE](LICENSE) file for details.