Scripting

You can use pkgx as the shebang for your scripts:

#!/usr/bin/env -S pkgx python@3.9

import sys

print(sys.version)
$ chmod +x ./my-script.py
$ ./my-script.py
3.9.17

Using env to invoke pkgx is typical for tools that have no POSIX location.

The -S parameter is required to pass multiple arguments.

Including Additional pkgs

Scripts are the glue that allows open source to be composed into powerful new tools. With our +pkg syntax you make anything in open source available to your script.

#!/usr/bin/env -S pkgx +openssl deno run

Deno.dlopen("libssl.dylib")

Robustness requires precisely specifying your environment:

#!/usr/bin/env -S pkgx bash>=4

source <(pkgx dev --shellcode)
# ^^ bash >=4 is required for this syntax, and eg macOS only comes with bash 3

Scripting for Various Languages & Their Dependencies

Python

Use uv to import PyPi dependencies:

#!/usr/bin/env -S pkgx +python@3.11 uv run --script

# /// script
# dependencies = [
#   "requests<3",
#   "rich",
# ]
# ///

import requests
from rich.pretty import pprint

resp = requests.get("https://peps.python.org/api/peps.json")
data = resp.json()
pprint([(k, v["title"]) for k, v in data.items()][:10])

Ruby

Use Bundler:

#!/usr/bin/env -S pkgx ruby@3

require 'bundler/inline'

gemfile do
  source 'https://rubygems.org'
  gem 'ruby-macho', '~> 3'
end

JavaScript & TypeScript

Use Deno:

#!/usr/bin/env -S pkgx deno@2 run

import fs from "npm:fs";

Rust, Go, C, C++, etc

Use Scriptisto:

#!/usr/bin/env -S pkgx +cargo scriptisto

# snip… type `pkgx scriptisto new cargo` for the rest.

Mash

We think pkgx scripting is so powerful that we made a whole package manager to show it off.

https://github.com/pkgxdev/mash

Other Examples

We make use of pkgx scripting all over our repositories. Check them out!

Last updated