How to Install tf-peek¶

This guide covers the available methods for installing tf-peek into your environment.

Prerequisites¶

Python 3.11 or later
pip, uv, or pipx available on your PATH

Install with pip¶

pip install tf-peek

Install with uv¶

uv tool install tf-peek

uv tool install places the tf-peek binary in an isolated environment managed by uv, keeping it separate from your project dependencies.

Install with pipx¶

pipx install tf-peek

pipx installs the tool in its own isolated virtual environment and exposes the tf-peek binary on your PATH.

Verify the installation¶

After installing, confirm that the binary is available:

tf-peek --version

And that its help output is accessible:

tf-peek --help

If the installed package is available but its console script is not on PATH, use the supported alternative invocation python -m tf_peek --help. Prefer tf-peek in documentation, scripts, and interactive use.

Install a specific version¶

If you need a specific release:

pip install tf-peek==1.0.0
# or
uv tool install tf-peek==1.0.0