configfile manages your configuration files (dotfiles) and setup scripts from a git repository you own. It copies each file where your tools expect it, runs your setup scripts, and keeps every machine in sync with the repository while keeping the changes your tools make on each machine, on macOS and Linux.
Documentation: docs.configfile.sh
Your repository groups files by tool, and says where each one goes:
files/
zsh/
configfile.module.json
zshrc
scripts/
setup.sh{
"files": [
{ "source_path": "zshrc", "target_path": "~/.zshrc", "deploy": "global" }
]
}On each machine:
configfile init --repo git@github.com:me/dotfiles.git # once
configfile modules deploy --all # copies ~/.zshrc, keeping the old one as ~/.zshrc.old
configfile scripts run setup # runs scripts/setup.sh
configfile update # later: brings the changes you pushedWith one command, on macOS or Linux (no package manager or Node.js needed):
curl -fsSL https://configfile.sh/install.sh | shWith Homebrew, on macOS or Linux (Node.js and git come with it):
brew install mindsers/tap/configfileWith npm, when Node.js 24.11 or later is installed:
npm install --global configfileInstallation has the details, including how to verify a download.
- Your first dotfiles repository: a ten-minute tutorial.
- How it works and Safety and trust: what configfile does with your files, and what it refuses to touch.
- Guides: set up a new machine, use configfile in scripts and CI, run scripts when a module is deployed, upgrade from 1.x, upgrade from 0.3.
- Reference: commands, modules and their settings, scripts, configuration, history.
- Changelog.
Contributions are welcome and greatly appreciated. Read How to contribute to configfile before opening a pull request, and follow the code of conduct.
- Questions and bugs: open an issue.
- Security vulnerabilities: never in a public issue. See the security policy.
configfile is free and open source software, under the Apache-2.0 license, built on my free time.
If you use it and want to support its development, you can sponsor me on GitHub Sponsors. Thank you!
The people who support configfile are listed in SPONSORS.md.
This project is under the Apache-2.0 license. See the LICENSE file.