Dotfiles

A collection of shell configuration files and utilities for a productive development environment.

Structure

• zsh/: ZSH shell configuration files
  • aliases/: Organized aliases by category
    • docker.zsh: Docker-related aliases
    • git.zsh: Git command shortcuts
    • github.zsh: GitHub CLI commands
    • code.zsh: VSCode related aliases
    • ibmcloud.zsh: IBM Cloud commands
    • velero.zsh: Velero-specific commands
    • misc.zsh: Miscellaneous aliases
  • alias.zsh: Main alias loader
  • colors.zsh: Color definitions
  • completions.zsh: Command completion configuration
  • paths.zsh: PATH environment variable configuration
  • util.zsh: Utility functions
  • znap.zsh: ZSH Snap plugin manager configuration
  • Other tool-specific configuration files

Usage

The main entry point is .zshrc which sources all the necessary files.

Key Commands

• copy-to-dotfiles-from-zshrc: Copy your local .zshrc to the dotfiles repo
• push-dotfiles-from-zshrc: Push changes to the dotfiles repository
• update-zshrc-from-dotfiles: Update your local .zshrc from the dotfiles repo

Migration Commands

• migrate-to-new-laptop: Set up a new laptop with your development environment
• export-wifi-credentials: Export WiFi network names for migration
• import-wifi-credentials: Import WiFi networks on new laptop
• list-wifi-networks: List currently saved WiFi networks

Features

• Organized aliases by category for better maintainability
• Efficient completion file caching
• Optimized utility functions
• Znap plugin manager for fast shell startup
• Comprehensive Git and GitHub workflow aliases
• Docker and container management shortcuts
• Cloud platform integrations (IBM Cloud, AWS, etc.)

Adding New Aliases

See zsh/aliases/README.md for instructions on adding new aliases to the appropriate category.

Dependencies

This dotfiles repository relies on several tools and utilities. Below is a list of all dependencies and how to install them using Homebrew:

Core Shell Tools

# Install ZSH (may already be installed on macOS)
brew install zsh

# Install required utilities for the shell
brew install coreutils

Plugin Manager & Plugins

# ZSH Snap (znap) will be automatically installed when you source the dotfiles
# The following plugins are managed by znap and will be installed automatically:
# - sindresorhus/pure (prompt)
# - zsh-users/zsh-syntax-highlighting
# - marlonrichert/zsh-autocomplete

Version Control Tools

# Git and GitHub related tools
brew install git
brew install gh
brew install jq  # Used in GitHub workflow aliases

# OpenCommit for AI-powered Git commits
npm install -g opencommit

Development & Container Tools

# Container tools
brew install podman
brew install docker  # or download Docker Desktop
brew install colima  # macOS container runtime alternative

# Docker buildx for multi-architecture builds
# (included with Docker Desktop or Docker CE >= 19.03)

# Code editors
brew install --cask visual-studio-code

# Local AI
brew install ollama

# YAML processing
brew install yq

# JSON processing 
brew install jq

# Go programming language
brew install go

Cloud & Kubernetes Tools

# Kubernetes and related tools
brew install kubernetes-cli  # kubectl
brew install kind
brew install krew  # kubectl plugin manager

# Cloud provider CLIs
brew install awscli
brew install google-cloud-sdk
brew install velero
brew install ibmcloud-cli

# OpenShift tools (alternative installation methods provided in functions)
# OpenShift CLI
brew install openshift-cli   # Or use the provided function: install-oc

# For OpenShift development
# install-ocp-installer  # Function provided in the repo
# For cloud credential operator
# install-ccoctl        # Function provided in the repo

Utility Tools

# General utilities
brew install gnu-sed
brew install socat
brew install spoof-mac
brew install lsof
brew install coreutils

# macOS specific
brew install --cask displaylink  # For external display support

Browser

# Microsoft Edge
brew install --cask microsoft-edge

Optional Tools

# Additional tools referenced in aliases
brew install --cask github
brew install --cask activepieces

Installation

After installing the dependencies above, clone this repository and source the .zshrc file:

git clone https://github.com/USERNAME/dotfiles.git ~/git/dotfiles
echo "source ~/git/dotfiles/.zshrc" >> ~/.zshrc

Replace USERNAME with your GitHub username.

Testing Changes

Before committing changes to ZSH configuration files:

# Check syntax of modified file
zsh -n ~/git/dotfiles/zsh/[modified-file].zsh

# Source and test the changes
source ~/git/dotfiles/zsh/[modified-file].zsh

# Test full shell reload
exec zsh

<3