Open-source project
paulirish/dotfiles avatar
paulirish/dotfiles

paulirish/dotfiles: a fish and bash setup the author tells you to steal from, not clone

paul's fish, bash, git, etc config files. good stuff.

4,361 stars1,249 forksShellLicense varies

At a glance

What is it?
Paul Irish's dotfiles repository is a working shell configuration, not a turnkey installer, and the README says so outright. It is worth reading for the fish function files, the .inputrc bindings and the handful of scripts that automate a fresh Mac, but cloning it wholesale is not what the author intends.
Who is it for?
Adopt this repository if you already use fish or bash on macOS and want a concrete reference for .inputrc bindings, folder jumping and machine bootstrap scripts. Do not adopt it as a dotfiles manager: there is no installer, no update path and no documented rollback, and the author himself points new users at mathiasbynens/dotfiles and alrra/dotfiles instead.
Can I use it commercially?
Not without permission. GitHub finds no licence file in the repository, and without a licence all rights are reserved by default: you may read the code but not reuse it. Check the README, or ask the authors, before using it.
Is it still maintained?
Yes. The repository last received commits 43 days ago.
What is it written in?
Mainly Shell, according to GitHub's language statistics.

Answers come from the project's GitHub data, last synced on November 14, 2026, and from our analysis. They are not legal advice.

From daily snapshots

Star history

  • paulirish/dotfiles4,361 ★ · +1
Star history
Repository2026-09-232026-11-14
paulirish/dotfiles4.4k4.4k

1 Stars in the last 52 days, measured from the daily GitHub snapshot. Compare with other projects

Editorial analysis

The author asks you to fork someone else's dotfiles instead

Wholesale adoption is refused at the top of the setup notes: you should not take the whole repository as your own, but a few files in it are worth stealing. The same idea governs pull requests, where suggestions are welcome but may be declined if they are not of personal value to the author. For a reader, that sets the intended use: this is a source of snippets and files, a place to look at how one engineer wired up two shells, not a package to install and forget. Newcomers are pointed at mathiasbynens/dotfiles and alrra/dotfiles as forks to start from instead. That framing matters more than the file count, because a repository of dotfiles is easy to mistake for a maintained distribution when it is really a personal notebook.

fish needs a submodule before its function files exist

The shell configuration covers fish and bash, with fish as the primary shell since 2016 and bash as a fallback. Fish carries a wrinkle: the repository ships a .gitmodules file, and the README tells fish users to run a submodule init.

bash
git submodule update --init

The shell environment files are flat files in the repository root: .aliases, .bash_profile, .bash_prompt, .bashrc, .exports, .functions, .profile and .hushlogin sit side by side. There is no package manifest and no install target, because the repository is designed to be read, then copied into place by hand.

symlink-setup.sh is the closest thing to an installer, and it is manual

The repository does contain a script whose job is installation, described as setting up symlinks for all dotfiles and vim config. It sits alongside setup-a-new-machine.sh, which the README describes as the random apps the author needs installed, and .macos, which is run on a fresh macOS setup. brew.sh and brew-cask.sh handle Homebrew initialization. Nothing in the repository wires these together: there is no bootstrap script that runs them in order, and the README does not document a rollback for whatever a given script has already changed. A reader who wants the full path must read each script before running it, then decide which parts of a personal machine they want rebuilt from someone else's defaults. The .macos file is described as sensible OS X defaults, with Mathias's repository named as the canonical source; the advice given is to run his or this one after reviewing it.

The .inputrc is the most portable piece in the repository

Of everything here, the bash readline configuration is the item with the least machine-specific surface. The claim made for it is that typing at the prompt becomes fast, and the specific behaviours behind that are: tab completion that does not prompt for a confirmation list of every possibility, history search by prefix so that typing cat followed by an up arrow recalls earlier cat commands, and case insensitivity for input. Those are all readline behaviours, so they apply to any bash session where .inputrc is loaded. That makes it the highest-value thing to lift out of a repository otherwise tied to macOS and to one person's alias set.

z, cdf and the ... aliases, and why z starts out useless

Folder navigation is the part a newcomer will notice first, because it is demoable in five lines.

sh
z dotfiles
z blog
....      # drop back equivalent to cd ../../..
z public
cdf       # cd to whatever's up in Finder

z jumps to a directory matched by name, cdf changes to whatever folder is open in Finder, and the ... aliases are literal shortcuts for repeated cd up operations. The catch is stated plainly in the README: z learns only once it is installed, so a fresh install has no database of your directory habits and the first attempts will land nowhere. The other constraint is platform. cdf depends on Finder, so the cdf line above does nothing on Linux, and the repository's setup scripts and .macos defaults are likewise macOS shaped.

The 2020 note admits four of the author's own tools are now obsolete

A section headed 2020 update lists newer tools the author rates highly, and one line is an outright retraction: delta is "a bit nicer than the diff-so-fancy project that i started." bat replaces cat, eza replaces ls and handles LS_COLORS theming, and git-fuzzy is described as deprecating his git recent script. Read as an adoption guide, this section says git-fuzzy deprecates the author's `git recent` script and that delta is nicer than diff-so-fancy, a project he started. The management question is left unresolved in the same section: a to-do list names homesick, chezmoi and the home-manager Nix project as candidates for replacing manual copying, with no decision recorded. So the repository has no update story for itself, and a reader who copies its `git recent` script inherits one the author has already marked as deprecated.

What chezmoi and home-manager change about the approach

The difference from a dotfiles manager is structural rather than stylistic. A manager such as chezmoi tracks a desired state in its own repository layout, renders that state into the home directory, and can diff or reapply it, so the file you edit on disk and the file in version control stay linked. Copying from this repository inverts that: the version control copy is upstream, your home directory is a manual copy, and no tool knows the difference between the two. GNU Stow attacks the same problem differently again by symlinking individual files into place from a package directory, which is closer to what symlink-setup.sh does by hand. Mathias's repository, named first in the README for people starting out, offers the plain fork-based approach and is named as the canonical source for OS X defaults. Paul Irish's contribution over those is the fish configuration and the .inputrc, not the process.

SSH key registration via security key, written down at last

One section exists because the author could not find the instructions anywhere else. To confirm that a hardware security key holds a usable key, run this on the client machine:

sh
ssh-add -L | grep ecdsa-sha2-nistp256@

The output is the ecdsa-sha2-nistp256 key to paste into the authorized_keys file on the remote host. There is a contradiction worth noting in this section's framing: the parenthesised note opens by assuming you have already moved off password authentication, and the key challenge is then presented as an alternative for anyone who wants it. The repository root also contains a .ssh.config.example file. Maintenance is a single fact worth stating plainly. The repository is not archived, and the last push was on 2026-10-03, with no GitHub releases published. The licence is not identified in the repository metadata the project publishes, so anyone planning to redistribute these files should confirm terms before copying them.

Editorial conclusion

Adopt this repository if you already use fish or bash on macOS and want a concrete reference for .inputrc bindings, folder jumping and machine bootstrap scripts. Do not adopt it as a dotfiles manager: there is no installer, no update path and no documented rollback, and the author himself points new users at mathiasbynens/dotfiles and alrra/dotfiles instead. Before copying anything, run the fish submodule init first and read symlink-setup.sh to see which paths it will overwrite in your home directory.

Frequently asked questions

how to install dotfiles

The repository has no installer. Its setup notes decline wholesale use and point new users to fork mathiasbynens/dotfiles or alrra/dotfiles instead, while symlink-setup.sh exists to set up symlinks for dotfiles and vim config by hand. Fish users should run git submodule update --init.

how to use dotfiles

Pick the individual files you want and copy them. The ones the author calls out are aliases.fish, functions.fish and fish/functions/* for fish, .aliases and .functions for bash, the .inputrc for readline behaviour, and .gitconfig for git aliases.

Can you provide some examples of dotfiles?

At the repository root you will find .aliases, .bash_profile, .bash_prompt, .bashrc, .config, .exports, .functions, .gemrc, .gitconfig, .hushlogin, .inputrc, .profile, .tmux.conf and .vimrc. Scripts for machine setup are setup-a-new-machine.sh, symlink-setup.sh, .macos, brew.sh and brew-cask.sh.

Official sources

  1. Issues
  2. paulirish/dotfiles on GitHub
  3. README
Add this badge to your README

If you maintain this project, the badge below links readers to this analysis and shows its maintenance status from the daily GitHub snapshot. Paste the markdown into your README; add ?metric=license or ?metric=stars to the image URL for a different field.

Add this badge to your README

markdown
[![Hysen Labs](https://hysenlabs.com/badge/paulirish-dotfiles.svg)](https://hysenlabs.com/projects/paulirish-dotfiles)

Star history chart for your README

markdown
[![Star history](https://hysenlabs.com/chart/paulirish-dotfiles.svg)](https://hysenlabs.com/projects/paulirish-dotfiles)

Was this useful?