Getting Started

  1. Homebrew

    brew install pkgxdev/made/pkgx
  2. cURL Installer

    Our installer both installs and upgrades pkgx:

    curl -fsS https://pkgx.sh | sh

    Wanna read that script before you run it? github.com/pkgxdev/setup/installer.sh

  3. Download Manually

    pkgx is a standalone binary, so you can just download it directly:

    # download it to `./pkgx`
    curl -o ./pkgx \
       --compressed --fail --proto '=https' \
       https://pkgx.sh/$(uname)/$(uname -m)
    
    # install it to `/usr/local/bin/pkgx`
    sudo install -m 755 pkgx /usr/local/bin

    For your convenience we provide a .tgz so you can one-liner that:

    curl -Ssf https://pkgx.sh/$(uname)/$(uname -m).tgz | sudo tar xz -C /usr/local/bin

    You can also download straight from GitHub Releases.

  4. Cargo

    cargo install pkgx
  5. Docker

    docker run -it pkgxdev/pkgx
    
    # or, eg.
    docker run pkgxdev/pkgx +python@3.10 node@22 start

    Or in your Dockerfile:

    FROM pkgxdev/pkgx
    RUN pkgx +node@16 npm start

    hub.docker.com/r/pkgxdev/pkgx

  6. GitHub Actions

    - uses: pkgxdev/setup@v2

    github.com/pkgxdev/setup

pkgx makes it easy to consistently use the GNU or BSD versions of core utilities across different platforms—handy for cross-platform CI/CD scripts.

pkgx +gnu.org/coreutils ls
  1. Arch Linux

    If you're on Arch Linux (or any of it's derivatives) you can also use the pkgx AUR (latest released version) or pkgx-git AUR (latest development version, might not be stable).

The AURs are community-maintained and might be out-of-date. Use them with caution.

Last updated