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

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.0.tar.gz (36.5 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.0-py3-none-any.whl (8.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: uvx_gh-0.1.0.tar.gz
  • Upload date:
  • Size: 36.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.21 {"installer":{"name":"uv","version":"0.9.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for uvx_gh-0.1.0.tar.gz
Algorithm Hash digest
SHA256 d888e125037b5146eea3e950572e4be66f830552824f95559969df88d0ca1aa3
MD5 80fad11c02292f4e75af4fada5345dd4
BLAKE2b-256 3e9df32c27439e5d5c3910e7f792760eff4cc37f26edc6da3ce8b10ef0c4fa53

See more details on using hashes here.

File details

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

File metadata

  • Download URL: uvx_gh-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 8.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.21 {"installer":{"name":"uv","version":"0.9.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for uvx_gh-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1dacf6a6f1a9789a55bbeb6cdcd51a3095ede19579e30f30cfb962a2acd27785
MD5 6a083dec01a7b5ee7ded872f23845ca8
BLAKE2b-256 76e2977f186e907320f69ed168e01805ba20de28f1052cca701a0fd366f06d07

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