Dotfiles

Colourful & robust configuration files and utilities for Mac, Linux and BSD. Installation is done with a simple command:

curl -L https://git.io/pmdot | sh

The short URL expands to GitHub-hosted ./install.sh, and then ./scripts/link.sh, which can be easily audited.

When invoked directly, the linker leaves conflicting files and symlinks untouched by default, prints their paths in red, and exits unsuccessfully. Existing correct links and identical copied files are accepted, so normal reruns remain idempotent. To replace conflicts explicitly, run:

./scripts/link.sh --overwrite

Displaced paths are preserved as .bak, .bak.1, and so on. Set NO_COLOR to disable colored output.

The top-level install.sh invokes the linker with --overwrite, so a full installation updates existing dotfiles while preserving backups.

Features

• No external dependencies! Great, when compared to oh-my-zsh.
• Auto-completion
• Syntax highlighting
• Useful utilities:
  • ff file-name-or-pattern - fast recursive search for a file name in directories.
  • tarbz2, untarbz2 - best archive compression. Utilizes parallel pbzip2 when available.
  • ram safari — show app RAM usage
  • curl http://site/v1/api.json | json - pretty-print JSON
• Git configuration and useful functions, loaded from config/git/config:
  • Opinionated git log, git graph
  • gcp for fast git commit -m ... && git push
  • git sign for PGP-signed git
  • git cleanup — clean up merged git branches. Very useful if you’re doing github pull requests in topic branches.
  • git_release — commit and tag the commit. Publishes to NPM for node projects.
  • git url - opens GitHub repo for current git repo.
  • git-changelog, git-setup etc.
• scripts/macos/defaults.sh — macOS fine tuning
• config/vscode — Sublime Text theme & settings
• Sets terminal tab and window title to current directory
• homesick / homeshick-compatible

Repository layout

• home/ — entrypoint files installed directly in $HOME.
• config/ — configuration for the shell, Git, Ghostty, terminal themes, Vim, and VS Code, including vendored Zsh plugins under config/shell/zsh/vendor/.
• scripts/ — linking and platform setup scripts.
• tests/ — syntax and clean-home installation smoke tests.

home/.zshrc is intentionally small: it resolves the checkout through its symlink and sources config/shell/zsh/zshrc.zsh.

Run the smoke test with ./tests/smoke.sh.

Git setup

Specify git author:

git config --global user.name "Diogenes of Sinope"
git config --global user.email "diogenes@barrel.com"

Map your current and historical commit addresses to the ME identity used by the log formatter. Add entries to config/git/mailmap:

ME <diogenes@barrel.com> <diogenes@barrel.com>
ME <diogenes@barrel.com> <diogenes@agora.example>

Enable GPG commit signing:

git config --global commit.gpgsign true
git config --global tag.gpgSign true
git config --global user.signingkey 697079DA6878B89B
# instead of 697079DA6878B89B, use specific key fingerprint

Instead of gnupg, there a lightweight gpgkp can optionally be used. Set gpgkp from key-producer as preferred signing program:

# npm install --global micro-key-producer
git config --global gpg.program $(which gpgkp)

License

The MIT License (MIT)

Copyright (c) 2011 Paul Miller (paulmillr.com)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.