Skip to content

README.md

Latest commit

 

History

History
344 lines (267 loc) · 10.4 KB

README.md

File metadata and controls

344 lines (267 loc) · 10.4 KB

Dotfiles

Personal configuration files for macOS (Apple Silicon), optimized for DevOps and cloud engineering workflows.

Contents

  • .zshrc - Zsh shell configuration with Oh My Zsh framework
  • .tmux.conf - Tmux terminal multiplexer configuration
  • ghostty/config - Ghostty terminal emulator configuration (tmux alternative)
  • .env.tpl - 1Password secret references (safe to commit, no actual secrets)
  • .gitignore - Git ignore rules

Features

Zsh Configuration

  • Framework: Oh My Zsh with robbyrussell theme
  • Version Managers: rbenv, pyenv, direnv
  • Node.js: Volta (primary), npm-global
  • Python: pixi, micromamba (conda environments via .conda_config)
  • Plugins: git, brew, gem, aws, docker, golang, tmux, kubectl, kubetail, kube-ps1, terraform
  • Cloud Tools: Google Cloud SDK, AWS CLI
  • Kubernetes: kubectl, stern, kube-ps1 for context display in prompt
  • Developer Tools:
    • GitHub CLI (gh) with interactive PR checkout via peco
    • Peco for interactive filtering and selection
    • GHQ for repository management
    • Hub for GitHub operations
  • Custom Aliases:
    • p: Navigate to projects using ghq + peco
    • b: Browse GitHub repository using hub + peco
    • v: Open project in VS Code using ghq + peco
    • c: Open project in Cursor using ghq + peco
    • ge: Open Emacs in Ghostty
    • C: Pipe output to clipboard (pbcopy)
    • Safety aliases: rm -i, cp -i, mv -i, mkdir -p
  • Enhanced Features:
    • Syntax highlighting and autosuggestions
    • 1M entry command history with deduplication and timestamp
    • Case-insensitive completion matching
    • Auto-cd by directory name
    • Japanese file name support
    • Emacs-style keybindings
    • Docker CLI completions

Tmux Configuration

  • Prefix: Ctrl-T (instead of default Ctrl-B)
  • Default Shell: Zsh
  • Terminal: tmux-256color with true color and italic support
  • Mouse Support: Enabled with scroll wheel
  • Clipboard: Native macOS integration via pbcopy (no reattach-to-user-namespace needed)
  • Key Bindings:
    • Ctrl-T: Next window
    • Ctrl-T v: Vertical split (preserves current path)
    • Ctrl-T h: Horizontal split (preserves current path)
    • Shift+Arrow: Navigate between panes
    • Ctrl-T r: Reload config
    • Ctrl-T Ctrl-C: Copy buffer to clipboard
    • Ctrl-T Ctrl-V: Paste from clipboard
  • History: 1,000,000 lines
  • Performance: Zero escape delay (escape-time 0), focus events enabled
  • Status Bar: Green background, session/window/host info in title
  • Plugins (via TPM):
    • tmux-resurrect (session save/restore)
    • tmux-continuum (auto-save every 15 min, auto-restore on start)

Ghostty Configuration

Modern GPU-accelerated terminal emulator with native multiplexing (alternative to tmux):

  • Default Shell: Zsh with native shell integration
  • Clipboard: Native integration (read/write allowed, trailing spaces trimmed)
  • Key Bindings:
    • Split Navigation: Shift+Arrow Keys to move between splits
    • All Ctrl+T chord keybindings are commented out (available to re-enable if needed)
  • Scrollback: 1,000,000 lines
  • Terminal: 256 color support (xterm-256color)
  • Font: Monaco, 12pt (ligatures disabled)
  • Theme: Dark+ with 95% background opacity
  • Session: Window state saved/restored on restart (window-save-state = always)
  • Safety: Confirm before closing surfaces with running processes
  • Layout: 4px window padding, white split divider, inherits working directory
  • Features: GPU-accelerated rendering, native split panes, auto-update checks

Secret Management

Secrets are managed via 1Password CLI (op) using a template-based approach with caching:

  • .env.tpl contains op:// references (no actual secrets) -- safe to commit
  • At shell startup, op inject resolves references and caches the result to ~/.cache/op_env_cache
  • Cache auto-refreshes every 24 hours -- Touch ID is only prompted once per day
  • Cache is created with umask 077 (owner-only permissions) and persists across shell sessions
  • Run op-reload to manually refresh secrets at any time

Adding a new secret

  1. Store the secret in 1Password (vault: Private, account: my.1password.com)
  2. Add a line to .env.tpl: 
    export MY_SECRET={{ op://Private/item-name/password }}
  3. Refresh secrets: op-reload (or source ~/.zshrc after cache expires)

Finding 1Password item paths

op item list --account=my.1password.com | grep -i <keyword>
op item get "<item-name>" --account=my.1password.com

Pre-commit Hooks

  • gitleaks scans staged changes for accidental secret commits
  • Install: brew install gitleaks

Requirements

Core Dependencies

  • macOS (optimized for Apple Silicon)
  • Homebrew
  • Oh My Zsh
  • Zsh (default shell on macOS)

Recommended Packages

# Terminal emulator and multiplexer
brew install ghostty              # Modern GPU-accelerated terminal (tmux alternative)
brew install tmux                 # Traditional terminal multiplexer
brew install peco

# Version managers
brew install rbenv
brew install pyenv
brew install direnv
brew install pixi

# Node.js (Volta)
curl https://get.volta.sh | bash

# Git and GitHub tools
brew install ghq
brew install hub

# Kubernetes tools
brew install stern
brew install kube-ps1

# Programming languages
brew install go
brew install openjdk

# Database clients
brew install postgresql@17
brew install mysql-client

# GNU utilities
brew install gnu-sed
brew install coreutils

# Secret management
brew install --cask 1password-cli
brew install gitleaks

# Google Cloud SDK (via Cask)
brew install --cask google-cloud-sdk

Zsh Plugins

# Zsh syntax highlighting
brew install zsh-syntax-highlighting

# Zsh autosuggestions
brew install zsh-autosuggestions

Installation

  1. Clone this repository:
git clone https://github.com/nsega/dotfiles.git ~/dotfiles
cd ~/dotfiles
  1. Backup existing configurations (if any):
mv ~/.zshrc ~/.zshrc.backup
mv ~/.tmux.conf ~/.tmux.conf.backup
  1. Create symlinks:
ln -s ~/dotfiles/.zshrc ~/.zshrc
ln -s ~/dotfiles/.tmux.conf ~/.tmux.conf

# For Ghostty configuration
mkdir -p ~/.config/ghostty
ln -sf ~/dotfiles/ghostty/config ~/.config/ghostty/config
  1. Install Oh My Zsh (if not already installed):
sh -c "$(curl -fsSL https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)"

  1. Install required dependencies (see Requirements section)

  2. Reload your shell:

source ~/.zshrc

Usage

Zsh Features

Interactive PR Checkout:

  • Press Ctrl-G Ctrl-P to interactively select and checkout a GitHub pull request using peco

Project Navigation:

  • Use p alias to navigate to projects managed by ghq (uses peco for selection)
  • Use b alias to browse GitHub repositories in your browser
  • Use v alias to open projects in VS Code
  • Use c alias to open projects in Cursor

Kubernetes Context:

  • Current kubectl context displayed in prompt via kube-ps1

Other Shortcuts:

  • Ctrl-R: History search with pattern matching
  • | C: Pipe command output to clipboard
  • Tab completion works case-insensitively

Tmux Commands

Basic Operations:

  • Start tmux: tmux
  • New session: tmux new -s <name>
  • Attach session: tmux attach -t <name>
  • List sessions: tmux ls

Window Management:

  • Ctrl-T c: Create new window
  • Ctrl-T: Next window
  • Ctrl-T n: Next window
  • Ctrl-T p: Previous window

Pane Management:

  • Ctrl-T v: Vertical split (opens in current directory)
  • Ctrl-T h: Horizontal split (opens in current directory)
  • Shift+Arrow: Navigate between panes

Clipboard:

  • Ctrl-T Ctrl-C: Copy tmux buffer to system clipboard
  • Ctrl-T Ctrl-V: Paste from system clipboard

Configuration:

  • Ctrl-T r: Reload tmux config

Ghostty Usage

Getting Started:

  • Launch Ghostty from Applications or via ghostty command
  • Configuration loads automatically from ~/.config/ghostty/config

Split Navigation:

  • Shift+Arrow Keys: Navigate between splits
  • Mouse click to focus a split

Configuration:

  • Edit ~/dotfiles/ghostty/config to customize settings
  • Ctrl+T chord keybindings are commented out but can be re-enabled as needed

Benefits over tmux:

  • GPU-accelerated rendering for better performance
  • Native split panes without separate multiplexer process
  • Direct clipboard integration without additional tools
  • Session restoration on restart

Configuration Details

Environment Variables

The .zshrc configures the following environment variables:

  • GOPATH: Set to $HOME
  • GOROOT: Points to Homebrew Go installation
  • GOMODCACHE: Set to $GOPATH/pkg/mod
  • GOTOOLCHAIN: Set to auto
  • VOLTA_HOME: Set to $HOME/.volta
  • CLOUDSDK_PYTHON: Uses pyenv Python 3
  • GPG_TTY: Configured for GPG signing
  • EDITOR: Set to /usr/bin/vi
  • LANG: Set to en_US.UTF-8

Zsh Settings

  • History: 1,000,000 entries with timestamp format mm/dd/yyyy
  • Oh My Zsh Updates: Every 13 days
  • Completion: Waiting dots enabled, case-insensitive matching
  • Behavior: Auto-cd, auto-pushd, share history across sessions

Paths

The configuration adds the following to PATH:

  • /opt/homebrew/bin and /opt/homebrew/sbin
  • /opt/homebrew/opt/openjdk/bin (Java)
  • /opt/homebrew/opt/openjdk@11/bin (Java 11)
  • /opt/homebrew/opt/postgresql@17/bin (PostgreSQL)
  • /opt/homebrew/opt/mysql-client/bin (MySQL)
  • /opt/homebrew/opt/gnu-sed/libexec/gnubin (GNU sed)
  • /opt/homebrew/opt/coreutils/libexec/gnubin (GNU coreutils)
  • $HOME/.krew/bin (kubectl plugins)
  • $HOME/.volta/bin (Volta / Node.js)
  • $HOME/.pixi/bin (pixi)
  • $HOME/.npm-global/bin (npm global packages)
  • $HOME/.pyenv/shims/python (Python)

Customization

Feel free to fork and customize these configurations for your own needs:

  • Modify the theme in .zshrc by changing ZSH_THEME
  • Add/remove Oh My Zsh plugins in the plugins array
  • Adjust tmux prefix key in .tmux.conf
  • Customize Ghostty appearance and behavior in ghostty/config:
    • Change font-family and font-size for different fonts
    • Modify theme for different color schemes
    • Adjust keybindings to match your workflow
    • Configure background-opacity for transparency effects
  • Add your own aliases and functions to .zshrc
  • Add secrets to .env.tpl using 1Password op:// references

License

Personal configuration files - use at your own discretion.

Author

nsega