diff options
Diffstat (limited to 'plugins/uv/README.md')
| -rw-r--r-- | plugins/uv/README.md | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/plugins/uv/README.md b/plugins/uv/README.md new file mode 100644 index 000000000..266963e18 --- /dev/null +++ b/plugins/uv/README.md @@ -0,0 +1,36 @@ +# 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` | +| uvi | `uv init` | Initialize a new project in current workspace and environment. | +| uvinw | `uv init --no-workspace` | Initialize a new project in a new workspace and environment | +| 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 | +| uvpi | `uv python install` | Install a specific version of python | +| uvpl | `uv python list` | Lists all python version installed | +| uvpp | `uv python pin` | Pin the current project to use a specific Python version | +| uvpu | `uv python uninstall` | Remove a specific version of python | +| 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 | +| uvtr | `uv tree` | Displays the full dependency tree for the current project environment | +| uvup | `uv self update` | Update the UV tool to the latest version | +| uvv | `uv venv` | Manage virtual environments | |