UpFile is a CLI tool for syncing files across multiple projects.
It's designed to help you manage shared configuration files like .prettierrc, .golangci.yml, or any other files.
UpFile operates on a simple but powerful principles:
- Each file identifies by unique
filename. - Each filename is associated with an
upstreamversion that acts as the source of truth. - You can add multiple instances of the same file across your projects. These
are called
entries. - Entry can be
pushedto the upstream and bepulledfrom it.
Suppose you have two projects: project-a and project-b, and both have the same config file .prettierrc.
~/project-a/.prettierrc
~/project-b/.prettierrc
And you want to keep them in sync, edit one file and easily spread changes to other places in other projects.
Use add to track each file:
$ upfile add ~/project-a/.prettierrc
$ upfile add ~/project-b/.prettierrcCheck tracked status:
$ upfile ls
test.txt:
/home/user/project-a/.prettierrc Up-to-date
/home/user/project-b/.prettierrc Up-to-dateMake a change in one entry and push it to the upstream.
$ echo 'change' >> ~/project-a/.prettierrc
$ upfile push ~/project-a/.prettierrcList to see status:
$ upfile ls
test.txt:
/home/user/project-a/.prettierrc Up-to-date
/home/user/project-b/.prettierrc Modified$ upfile sync test.txt
The following tracked files will be updated:
- /home/user/project-b/.prettierrc
Proceed? [Y/n]: yNow both files are consistent again.
For a complete list of commands and detailed usage instructions, run:
upfile -hyay -S upfile-binbrew install skewb1k/homebrew-tap/upfileSupport for other package managers is planned.
Or download a binary from the releases page.
go install github.com/skewb1k/upfile/cmd/upfile@latest$UPFILE_DIR- Path to the directory where UpFile stores metadata and upstream file versions. By default$XDG_DATA_HOME/upfile
UpFile supports advanced and interactive shell completion for Bash, Zsh, fish, and PowerShell.
See the instructions on upfile completion <YOUR_SHELL> -h
Contributions are welcome. If you find a bug, have an idea, or want to improve something — feel free to open an issue or submit a pull request.
Before committing, please make sure the code passes linting and tests:
task lint test