Installation¶

Two commands for each package manager: one to install, one to upgrade. We strongly recommend uv; pip works but installs into whichever Python interpreter you run it with.

⚠️ Exit any running termapy before upgrading. The running program holds its own binary open, so the package manager can't replace the files cleanly. On Windows the upgrade will fail outright with a file-in-use error. On macOS and Linux the upgrade command will usually succeed, but you'll keep running the old code in the live process until you exit and relaunch -- confusing if you're expecting a fix or feature from the new release. Close every termapy window, run the upgrade command, then relaunch.

uv (recommended)¶

Install:

uv tool install "termapy[all]"

Upgrade:

uv tool upgrade termapy

pip¶

Install:

pip install "termapy[all]"

Upgrade:

pip install --upgrade "termapy[all]"

What [all] includes¶

[all] is a catch-all that bundles every optional extra so you don't have to think about it. Lazy imports inside termapy mean unused deps cost nothing at runtime: TUI/CLI users never load pydantic, and --mcp users never load Textual. The only tradeoff is disk footprint -- [all] adds ~16 MB on top of the base install -- which is rounding error on any modern dev machine.

Slim installs¶

If you specifically need a smaller footprint (embedded targets, slim containers, paranoid security review), pick individual extras:

--mcp requires the [mcp] extra (or [all]) and exits with an install hint if it's missing. Same for --web and [web].

Uninstall¶

uv tool uninstall termapy

Or, if installed with pip:

pip uninstall termapy