@@ -29,6 +29,9 @@ $ pkgx +rust
2929# if there’s output, we got it
3030` ` `
3131
32+ > See [`@pkgxdev/dev`] to run the `dev` command in a GitHub Actions compatible manner
33+
34+
3235# ## Shell Integration
3336
3437We cannot integrate with the GitHub Actions shell. But you probably don’t
@@ -42,7 +45,7 @@ just slow things down.
4245
4346
4447
45- # `pkgx` Installer
48+ # The `pkgx` Installer
4649
4750To install `pkgx` :
4851
@@ -53,25 +56,34 @@ $ curl https://pkgx.sh | sh
5356# - if pkgx is already installed it’s a noop
5457```
5558
59+ ## Temporary Sandboxes
60+
5661To use ` pkgx ` to run a command in a temporary sandbox:
5762
5863``` sh
5964$ curl -Ssf https://pkgx.sh | sh -s -- gum spin -- sleep 5
6065
6166# - if pkgx is installed, uses that installation to run gum
62- # - if pkgx is *not * installed, downloads pkgx to a temporary location
63- # - packages are still cached in `~/.pkgx` but pkgx itself is not installed
67+ # - if pkgx *isn’t * installed, downloads pkgx to a temporary location
68+ # - if pkgx *isn’t* installed, packages are also cached to a temporary location
6469```
6570
71+ > This usage of our installer can be useful for demonstrative purposes in
72+ > READMEs and gists.
73+
6674This syntax is easier to remember:
6775
6876``` sh
6977sh <( curl -L pkgx.sh) gum spin -- sleep 5
7078```
7179
72- > There is the ** notable caveat** that it will not work with bash <4
80+ > There is the ** notable caveat** that the above easier syntax will not work with bash <4
7381> which is the bash that comes with macOS. Even though macOS has defaulted to
7482> zsh for years it is still relatively easy for users to end up in a situation
75- > where bash is the shell interpreting your commands. Your call.
83+ > where bash is the shell interpreting your commands. ** Your call** .
84+ >
85+ > Additionally, use of ` -L ` is subject to man-in-the-middle attacks.
86+ > Again ** your call** .
7687
7788[ `action.yml` ] : ./action.yml
89+ [ `@pkgxdev/dev` ] : https://github.com/pkgxdev/dev
0 commit comments