Skip to content

Version

version

Version checking for Crux — local version and PyPI update checks.

current_version 

current_version()

Return the currently installed version string.

Source code in src/crux_cli/version.py 
19
20
21
def current_version() -> str:
    """Return the currently installed version string."""
    return __version__

check_pypi_version 

check_pypi_version(*, timeout=5.0)

Query PyPI for the latest crux-cli version.

Source code in src/crux_cli/version.py 
24
25
26
27
28
29
30
31
32
33
34
35
def check_pypi_version(*, timeout: float = 5.0) -> str | None:
    """Query PyPI for the latest crux-cli version."""
    try:
        req = urllib.request.Request(PYPI_URL, headers={"Accept": "application/json"})  # noqa: S310
        with urllib.request.urlopen(req, timeout=timeout) as resp:  # noqa: S310
            data = json.loads(resp.read().decode())
        ver = data["info"]["version"]
        if not isinstance(ver, str) or not _VERSION_RE.match(ver):
            return None
        return ver
    except (urllib.error.URLError, OSError, KeyError, json.JSONDecodeError, ValueError):
        return None

format_version_output 

format_version_output(*, check=False)

Build the human-readable version string.

Source code in src/crux_cli/version.py 
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
def format_version_output(*, check: bool = False) -> str:
    """Build the human-readable version string."""
    local = current_version()

    if not check:
        return f"crux-cli v{local}"

    latest = check_pypi_version()

    if latest is None:
        return f"crux-cli v{local} (could not check for updates)"

    try:
        local_ver = Version(local)
        latest_ver = Version(latest)
    except InvalidVersion:
        if latest != local:
            return f"Update available: v{local} → v{latest}. Run: uv tool upgrade crux-cli"
        return f"crux-cli v{local} (up to date)"

    if latest_ver > local_ver:
        return f"Update available: v{local} → v{latest}. Run: uv tool upgrade crux-cli"
    if local_ver > latest_ver:
        return f"crux-cli v{local} (ahead of PyPI v{latest})"

    return f"crux-cli v{local} (up to date)"