Skip to content

About

Manage your dotfiles and setup scripts from a git repository.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

2 stars

Watchers

1 watching

Forks

configfile

Release CI License GitHub Sponsors

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

How it looks

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 pushed

Installation

With one command, on macOS or Linux (no package manager or Node.js needed):

curl -fsSL https://configfile.sh/install.sh | sh

With Homebrew, on macOS or Linux (Node.js and git come with it):

brew install mindsers/tap/configfile

With npm, when Node.js 24.11 or later is installed:

npm install --global configfile

Installation has the details, including how to verify a download.

Learn more

Contribution

Contributions are welcome and greatly appreciated. Read How to contribute to configfile before opening a pull request, and follow the code of conduct.

Support

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.

License

This project is under the Apache-2.0 license. See the LICENSE file.

About

Manage your dotfiles and setup scripts from a git repository.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

2 stars

Watchers

1 watching

Forks

Releases

Sponsor this project

Packages

Used by

Contributors

Languages