Like Brewfile but for UV
Project description
uvfile
Tools management for uv. Think Brewfile, but for Python CLI tools.
Note: Most of this tool, was written by Pseudocoder and the most of the readme was written by Claude based on my design and requirements. It works, but the implementation has room for improvement. I focused on the interface and user experience while delegating the implementation details to the LLM.
uv tool install uvfile
Why?
You want to track and sync your globally installed Python CLI tools across different environments,
but uv tool install doesn't provide a way to save and restore tool states. With uvfile you can:
- Initialize a manifest of your system-wide Python tools
- Sync tools across different machines
- Track tool versions and their extras
- Share common tooling within teams while allowing personal tools
Usage
Initialize UVFile from currently installed tools
uvfile init
Install tools from UVFile
uvfile sync # Install missing tools
uvfile sync --pin # Install and match exact versions
uvfile sync --force # Force reinstall all tools in UVFile
uvfile sync --clean # Remove tools unlisted in UVFile
uvfile sync --pin --clean
uvfile sync --force --clean
Combine sync options
uvfile sync --pin --clean
uvfile sync --force --clean
Preview changes
Add --dry-run to sync commands
uvfile sync --force --clean --dry-run
Would run: uv tool uninstall cowsay
Would run: uv tool install aider-chat --python python3.12 --reinstall
Would run: uv tool install cookiecutter --reinstall
Would run: uv tool install lefthook --reinstall
Would run: uv tool install poetry --reinstall
Would run: uv tool install project-mapper@https://github.com/blakesims/project-mapper.git --reinstall
Would run: uv tool install pypyp --reinstall
Would run: uv tool install ruff --reinstall
Would run: uv tool install type-ignore@https://github.com/cleder/type-ignore.git --reinstall
Would run: uv tool install uvfile --reinstall
Shell Integration
Add this to your shell config:
if command -v uvfile >/dev/null 2>&1; then
source <(uvfile env)
fi
This will:
- Auto-update UVFile after
uv tool install/upgrade - Add
uv filecommand as an alias for uvfile - Add shell completions
Use Cases
Multiple Machines
Keep tools in sync across different computers:
On main machine
uvfile init
git add UVFile
git commit -m "Add my local uv tools via UVFile"
git push
On other machines
git pull
uvfile sync --pin # Install while preserving existing tools
Team Standards
Share common tooling while allowing personal tools:
uvfile --uvfile ~/work/project/UVFile sync --pin # Install team tools, keep personal ones
CI/CD
Ensure consistent tooling in CI:
steps:
- uses: actions/checkout@v4
- run: |
curl -L https://github.com/astral-sh/uv/releases/latest/download/uv-installer.sh | sh
uvfile sync
UVFile Format
UVFile uses a simple format that mirrors uv tool install commands:
ruff>=0.2.0 --python 3.11
mypy==1.8.0
black --with tomli --with typing-extensions>=4.0
pdm --with-editable ./dev-tools/pdm-plugin
Supports:
- Version constraints
- Python version specification
- Additional dependencies via
--with - Editable installs via
--with-editable - Git repositories
- Local directories
Environment Variables
UVFILE_PATH: Override the default UVFile location (defaults to./UVFile)
Limitations
- Doesn't provide a way to merge different UVFiles: you can use multiple UVFiles via different sync options, but there's no way to partially update UVFile, except for manual edits, of course (PRs welcome).
- Doesn't support all extra arguments (PRs welcome).
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file uvfile-0.2.0.tar.gz.
File metadata
- Download URL: uvfile-0.2.0.tar.gz
- Upload date:
- Size: 9.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.10.6 {"installer":{"name":"uv","version":"0.10.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
dc8023dd46ccc131583d2b39bf3a09666f0ffad02ff8f2942afb96d73dd6679a
|
|
| MD5 |
f7b50132f07bd1558474354181b5c4dd
|
|
| BLAKE2b-256 |
ca828055cf3e6d343db9a92e660d3e901495763fa28b51fdf1606dc5114932f1
|
File details
Details for the file uvfile-0.2.0-py3-none-any.whl.
File metadata
- Download URL: uvfile-0.2.0-py3-none-any.whl
- Upload date:
- Size: 8.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.10.6 {"installer":{"name":"uv","version":"0.10.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9b46ed285b530375cbbf65652a5306245bb8690c438adf81621909646fc6d64e
|
|
| MD5 |
4bdfe7f4fcbaa944891b26e7dd394d29
|
|
| BLAKE2b-256 |
3b22eae79fe190ee91995b84d5e2f024067d48ad5b9ed3c2c59bbae20cacd890
|