Installation¶

Requirements¶

Python 3.11 or later
uv — used both to install exsh and to manage dev dependencies

Install as a tool¶

The recommended way is to install exsh from PyPI as a uv tool so it is available system-wide:

uv tool install exist-shell

Or with pipx:

pipx install exist-shell

Verify the installation:

exsh --version

Run without installing¶

uvx --from exist-shell exsh --version

uvx runs the command in a temporary, cached environment without installing it permanently — useful for trying out exsh or running a one-off command.

Upgrade¶

uv tool upgrade exist-shell

Uninstall¶

uv tool uninstall exist-shell

Install from git¶

To install an unreleased commit instead of the latest PyPI release:

uv tool install git+https://github.com/ambs/exist-shell

Install from a local clone¶

If you want to develop or test from source:

git clone https://github.com/ambs/exist-shell
cd exist-shell
uv sync

The exsh command is then available inside the project's virtual environment:

.venv/bin/exsh --help

Or activate the environment first:

source .venv/bin/activate
exsh --help