Installation

Stable release

It is recommended to install with uv:

uv tool install uv-workon

To include the ability to manage ipykernel, include the jupyter extra:

uv tool install "uv-workon[jupyter]"

Add autocompletion

Run the following to add autocompletion for uv-workon:

uv-workon --install-completion

Shell integration

To use uv-workon activate and uv-workon cd, you must enable the shell configuration with `eval “$(uv-workon shell-config)”, or add it to you config script with:

# for zsh
echo 'eval "$(uv-workon shell-config)"' >> ~/.zshrc
# for bash
echo 'eval "$(uv-workon shell-config)"' >> ~/.bashrc
# for fish
echo 'uv-workon shell-config | source' >> ~/.config/fish/completions/uv-workon.fish

Open a issue if you need support for another shell.

This is the preferred method to install uv-workon, as it will always install the most recent stable release.

From sources

See Contributing for details on installing from source.