Installation

Installation

warden needs Python 3.11 or newer. Everything below uses uv, which brings its own Python if the machine has none.

From a checkout

git clone https://github.com/vxnsin/warden
cd warden
uv sync
uv run warden

uv run warden prints the banner and the list of commands. If you see that, it works.

As a command of its own

To drop the uv run in front:

uv tool install .

This puts a warden executable in uv's tool directory and, on most systems, on your PATH:

System	Location
Windows	%USERPROFILE%\.local\bin\warden.exe
Linux, macOS	~/.local/bin/warden

Check it:

warden --version

If the shell cannot find it, uv will have said which directory to add to PATH; uv tool update-shell does it for you on most shells.

Not on PyPI

uv tool install warden by name does not work — warden is not published, and that name is taken there by an unrelated package. Install from the checkout as above. Publishing under a different distribution name is tracked in issue #1.

Upgrading

cd warden
git pull
uv sync
uv tool install . --force     # only if you installed it as a command

The registry database survives upgrades. A schema change adds what it needs when the database is next opened, so nothing has to be thrown away.

Removing it

uv tool uninstall warden

The database is not removed with it. Delete it by hand if you want it gone:

System	Path
Windows	%LOCALAPPDATA%\warden\registry.db
Linux	~/.local/share/warden/registry.db
macOS	~/Library/Application Support/warden/registry.db