Get Started

Install the shared configuration

Your machine-local ~/.zshrc owns Oh My Zsh, Starship, PATH and completion initialization. The shared modules load from ~/.config/zsh. Clone into an empty target directory:

$ git clone https://github.com/Thundernirmal/zsh.git "$HOME/.config/zsh"

Add this to ~/.zshrc after Oh My Zsh if the shared aliases should override framework defaults:

if [ -r "$HOME/.config/zsh/init.zsh" ]; then
  source "$HOME/.config/zsh/init.zsh"
fi

Without a framework, initialize completion before that snippet:

$ autoload -Uz compinit && compinit -i

Check your tools

The intended setup uses Zsh, git, curl, ss, lsd, zoxide and fzf. Every fuzzy picker requires stable fzf 0.68.0 or newer. Optional tools enable extra workflows; each command reference lists its requirements.

$ $HOME/.config/zsh/scripts/check-deps.sh

Restart your shell after installing dependencies. The configuration loads heavy command domains on first use.

Find your first command

$ zdoctor

zdoctor diagnoses setup and integration status. Then run zhelp --plain to browse commands or zhelp package to find package workflows. The interactive palette queues an editable example.

Browse Commands · Troubleshooting