diff options
| author | Sebastian Correa <43179146+sebastian-correa@users.noreply.github.com> | 2024-10-07 16:50:56 -0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-10-07 21:50:56 +0200 |
| commit | d59f2fac36ac7d83d33c0054b1de33cce54e3210 (patch) | |
| tree | b35dc9808e2e51f4dd5b5a75b3129bd180f0973b /plugins/uv/README.md | |
| parent | 62cf1201b031399e7251abeee859e895ee825a48 (diff) | |
| download | zsh-d59f2fac36ac7d83d33c0054b1de33cce54e3210.tar.gz zsh-d59f2fac36ac7d83d33c0054b1de33cce54e3210.tar.bz2 zsh-d59f2fac36ac7d83d33c0054b1de33cce54e3210.zip | |
feat(uv): add `uv` plugin (#12702)
The uv plugin adds shell completions and many useful aliases.
Diffstat (limited to 'plugins/uv/README.md')
| -rw-r--r-- | plugins/uv/README.md | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/plugins/uv/README.md b/plugins/uv/README.md new file mode 100644 index 000000000..1b99c1185 --- /dev/null +++ b/plugins/uv/README.md @@ -0,0 +1,28 @@ +# uv plugin + +This plugin automatically installs [uv](https://github.com/astral-sh/uv)'s completions for you, and keeps them up to date. It also adds convenient aliases for common usage. + +To use it, add `uv` to the plugins array in your zshrc file: + +```zsh +plugins=(... uv) +``` + +## Aliases + +| Alias | Command | Description | +|:----- |------------------------------------------------------------------------ |:-------------------------------------------------------------------- | +| uva | `uv add` | Add packages to the project | +| uvexp | `uv export --format requirements-txt --no-hashes --output-file requirements.txt --quiet` | Export the lock file to `requirements.txt` | +| uvl | `uv lock` | Lock the dependencies | +| uvlr | `uv lock --refresh` | Rebuild the lock file without upgrading dependencies | +| uvlu | `uv lock --upgrade` | Lock the dependencies to the newest compatible versions | +| uvp | `uv pip` | Manage pip packages | +| uvpy | `uv python` | Manage Python installs | +| uvr | `uv run` | Run commands within the project's environment | +| uvrm | `uv remove` | Remove packages from the project | +| uvs | `uv sync` | Sync the environment with the lock file | +| uvsr | `uv sync --refresh` | "Force" sync the environment with the lock file (ignore cache) | +| uvsu | `uv sync --upgrade` | Sync the environment, allowing upgrades and ignoring the lock file | +| uvup | `uv self update` | Update the UV tool to the latest version | +| uvv | `uv venv` | Manage virtual environments | |