Skip to main content

Thin wrapper to uvx-run a tool from github.com/<user>/<tool>[@<ref>].

Project description

uvx-gh

Thin wrapper to uvx-run a tool published as a GitHub repo at github.com/<user>/<tool>[@<ref>].

Install

# One-off run
uvx uvx-gh alice/foo

# Or install
pip install uvx-gh
# pip install git+https://github.com/qsoyq/uvx-gh.git    # latest from GitHub

Usage

uvx-gh [uvx-options...] USER/TOOL[@REF] [tool-args...]
uvx-gh [uvx-options...] --user USER TOOL[@REF] [tool-args...]

The USER/TOOL short path takes priority over --user. Either is required.

Ref suffix

Spec Behavior
alice/foo use locally cached HEAD sha; first call resolves via git ls-remote and persists
alice/foo@latest force re-resolve HEAD via git ls-remote and overwrite the cached sha
alice/foo@v1.2.3 pin to git ref (tag / branch / sha) directly — bypasses the sha cache

Extras (PEP 508)

Append [extras] to the tool name to request optional dependency groups, just like pip install pkg[extras]:

# httpx CLI requires the [cli] extras (click + pygments + rich) to actually run
uvx-gh encode/httpx[cli] -- https://example.com

# Multiple extras + a pinned ref
uvx-gh "encode/httpx[cli,http2]@master" -- https://example.com

Internally this becomes a PEP 508 direct reference forwarded to uvx:

uvx --from "httpx[cli] @ git+https://github.com/encode/httpx@<sha>" httpx ...

Extras do not participate in the sha cache key — the same <user>/<tool> shares one ls-remote result across every extras combination, and @latest on any variant refreshes the sha for all of them. uv keeps a separate venv per extras combination under ~/.cache/uv/environments-v2/<hash>/.

Quote the spec when extras contain commas, otherwise the shell may treat , or brackets specially in some contexts.

--no-git (skip the system git binary)

uv itself shells out to the system git binary when installing a git+https:// source. On hosts without git (typical Windows boxes that only have uv installed), the install fails with Git executable not found.

Pass --no-git (or set UVX_GH_NO_GIT=1) to emit a GitHub archive tarball URL instead — uv then downloads over plain HTTP and never calls git:

uvx-gh --no-git qsoyq/ai-assistant -- --help
# → uvx --from "https://github.com/qsoyq/ai-assistant/archive/<sha>.tar.gz" ai-assistant --help

Caveats:

  • Public repos only. Private repos still need git credentials.
  • uv does not reuse a git checkout cache for tarballs, so each new sha re-downloads.

Why the sha cache?

uvx --from git+https://... (without a pinned commit) makes uv re-fetch HEAD from GitHub on every call — that's a network roundtrip per invocation. uvx-gh resolves HEAD itself via the smart-HTTP ls-remote protocol (using dulwich, no system git needed) and pins the URL to the resolved sha (git+...@<sha>). After the first run, subsequent calls hit the local cache and incur zero network traffic until you explicitly use @latest.

Cache location:

  • $UVX_GH_CACHE_HOME if set
  • otherwise $XDG_CACHE_HOME/uvx-gh/ (default ~/.cache/uvx-gh/)

Layout: <cache_dir>/github.com/<user>/<tool> containing the sha as a single line.

Pass-through

Anything the wrapper does not recognize is forwarded:

  • Tokens before TOOL_SPEC go to uvx (e.g. --python 3.12, --with extras)
  • Tokens after TOOL_SPEC go to the tool itself
  • -- ends wrapper-arg parsing; everything after -- is treated as tool args
uvx-gh --python 3.12 alice/foo --port 8080
# → uvx --python 3.12 --from git+https://github.com/alice/foo foo --port 8080

uvx-gh -- alice/foo --user bob
# → uvx --from git+https://github.com/alice/foo foo --user bob
#   (--user bob is forwarded to foo, NOT consumed by uvx-gh)

Requirements

uvx-gh depends on the uv toolchain (which provides the uvx binary). It does not require the system git CLI — HEAD resolution uses dulwich (pure Python, bundled as a runtime dep).

Install uv:

Platform Command
macOS brew install uv
Linux curl -LsSf https://astral.sh/uv/install.sh | sh
Windows winget install --id=astral-sh.uv -e
Any pipx install uv

uvx-gh runs a pre-flight check at startup and exits with a friendly message if uvx is not on PATH.

Notes

  • On Windows, os.execvp is emulated; signal/exit-code semantics differ slightly from POSIX.
  • The UVX_VALUE_FLAGS whitelist in uvx_gh/commands/main.py is hand-synced with uv's value-taking flags. Use --flag=value form to bypass the whitelist if a new uv flag is missing.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

uvx_gh-0.1.4.tar.gz (38.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

uvx_gh-0.1.4-py3-none-any.whl (10.3 kB view details)

Uploaded Python 3

File details

Details for the file uvx_gh-0.1.4.tar.gz.

File metadata

  • Download URL: uvx_gh-0.1.4.tar.gz
  • Upload date:
  • Size: 38.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.14 {"installer":{"name":"uv","version":"0.11.14","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for uvx_gh-0.1.4.tar.gz
Algorithm Hash digest
SHA256 fd7318a0d86226da96ad78af1fef815859a29c8de721983d152bc7920193bb0b
MD5 e0e69454f39c19b045bf374b59a1bebf
BLAKE2b-256 b645fac86849c64043495e98a199d952a4908a43047e140457d31f48d71c4b36

See more details on using hashes here.

File details

Details for the file uvx_gh-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: uvx_gh-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 10.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.14 {"installer":{"name":"uv","version":"0.11.14","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for uvx_gh-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 f7d32cfde1653f0702a3d53ff15dee20edf2096eea94dec64b14ffb178502fbf
MD5 e56733a33df76609a1986172dab60ab3
BLAKE2b-256 a70886723ba11d97a91a8a61312f421c603aa0a742b9bca5726b1a515172835f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page