11![ pkgx.dev] ( https://pkgx.dev/banner.png )
22
3- ` pkgx ` is a 4 MiB, standalone binary that can * run anything * .
3+ ` pkgx ` is a 4 MiB, standalone binary that can _ run anything _ .
44
55[ ![ coverage] [ ]] [ coveralls ] [ ![ teaRank] [ ]] ( https://tea.xyz )
66
77  ;
88
9-
109### Quickstart
1110
1211``` sh
@@ -17,7 +16,6 @@ brew install pkgx || curl https://pkgx.sh | sh
1716
1817  ;
1918
20-
2119# Run Anything
2220
2321``` sh
@@ -33,8 +31,7 @@ command not found: deno
3331# ^^ nothing was installed; your wider system is untouched
3432```
3533
36-
37- ## Run * Any Version* of Anything
34+ ## Run _ Any Version_ of Anything
3835
3936``` sh
4037$ pkgx node@14 --version
@@ -44,19 +41,18 @@ $ pkgx python@2 --version
4441Python 2.7.18
4542```
4643
47-
4844## Run Anywhere
4945
5046<details ><summary >macOS</summary ><br >
5147
52- * macOS >= 11
53- * 64 bit Intel & Apple Silicon
48+ - macOS >= 11
49+ - 64 bit Intel & Apple Silicon
5450
5551</details >
5652<details ><summary >Linux</summary ><br >
5753
58- * glibc >=2.28 [ repology] ( https://repology.org/project/glibc/versions )
59- * ` x86_64 ` & ` arm64 `
54+ - glibc >=2.28 [ repology] ( https://repology.org/project/glibc/versions )
55+ - ` x86_64 ` & ` arm64 `
6056
6157> [ !TIP]
6258> We have gone to good lengths to make ` pkgx ` (and the packages it installs)
@@ -65,7 +61,7 @@ Python 2.7.18
6561</details >
6662<details ><summary >Windows</summary ><br >
6763
68- WSL2; x86-64. * Native windows is planned.*
64+ WSL2; x86-64. _ Native windows is planned._
6965
7066</details >
7167<details ><summary >Docker</summary ><br >
@@ -132,9 +128,8 @@ pkgx shellcheck
132128</details >
133129<details ><summary >Editors</summary ><br >
134130
135- Use [ ` dev ` ] [ dev ] ; a separate tool that uses the pkgx primitives to
136- automatically determine and utilize your dependencies based on your
137- project’s keyfiles.
131+ Use [ ` dev ` ] [ dev ] ; a separate tool that uses the pkgx primitives to automatically
132+ determine and utilize your dependencies based on your project’s keyfiles.
138133
139134``` sh
140135$ cd myproj
@@ -149,16 +144,15 @@ myproj $ code .
149144
150145  ;
151146
152-
153147# The ` pkgx ` Ecosystem
154148
155149` pkgx ` is not just a package runner, it’s a composable primitive that can be
156150used to build a whole ecosystem of tools.
157151
158152## ` dev `
159153
160- ` dev ` uses ` pkgx ` and shellcode to create “virtual environments” consisting
161- of the specific versions of tools and their dependencies you need for your
154+ ` dev ` uses ` pkgx ` and shellcode to create “virtual environments” consisting of
155+ the specific versions of tools and their dependencies you need for your
162156projects.
163157
164158``` sh
@@ -178,14 +172,12 @@ Compiling my-rust-proj v0.1.0
178172
179173> [ github.com/pkgxdev/dev] [ dev ]
180174
181-
182175## ` pkgm `
183176
184177` pkgm ` installs ` pkgx ` packages to ` /usr/local ` . It installs alongside ` pkgx ` .
185178
186179> [ github.com/pkgxdev/pkgm] [ pkgm ]
187180
188-
189181## Scripting
190182
191183A powerful use of ` pkgx ` is scripting, eg. here’s a script to release new
@@ -209,15 +201,15 @@ gh release create \
209201 --notes-start-tag=v$v_latest
210202```
211203
212- Above you can see how we “loaded” the shebang with ` +pkg ` syntax to bring in
213- all the tools we needed.
204+ Above you can see how we “loaded” the shebang with ` +pkg ` syntax to bring in all
205+ the tools we needed.
214206
215207> We have pretty advanced versions of the above script, eg
216208> [ teaBASE] [ teaBASE-release-script ]
217209
218210There’s tools for just about every language ecosystem so you can import
219- dependencies. For example, here we use ` uv ` to run a python script with
220- pypi dependencies, and pkgx to load both ` uv ` and a specific python version:
211+ dependencies. For example, here we use ` uv ` to run a python script with pypi
212+ dependencies, and pkgx to load both ` uv ` and a specific python version:
221213
222214``` sh
223215#! /usr/bin/env -S pkgx [email protected] uv run@@ -241,8 +233,8 @@ pprint([(k, v["title"]) for k, v in data.items()][:10])
241233>
242234> # ## Mash
243235>
244- > We love scripting with ` pkgx` so much that we made a whole package manager
245- > for scripts to show the world what is possible when the whole open source
236+ > We love scripting with ` pkgx` so much that we made a whole package manager for
237+ > scripts to show the world what is possible when the whole open source
246238> ecosystem is available to your scripts Check it out [` mash` ].
247239
248240> [! NOTE]
@@ -285,15 +277,13 @@ though it was installed all along.
285277
286278& nbsp;
287279
288-
289280# Further Reading
290281
291282[docs.pkgx.sh][docs] is a comprehensive manual and user guide for the ` pkgx`
292283suite.
293284
294285& nbsp;
295286
296-
297287# Migrating from `pkgx`^1
298288
299289# # Shellcode
@@ -321,8 +311,8 @@ exported.
321311
322312# # `pkgx install`
323313
324- We now provide [` pkgm` ][pkgm] but if you miss the leanness of “stubs” we
325- provide a [` mash` ] script to create stubs in ` /usr/local/bin` :
314+ We now provide [` pkgm` ][pkgm] but if you miss the leanness of “stubs” we provide
315+ a [` mash` ] script to create stubs in ` /usr/local/bin` :
326316
327317` ` ` sh
328318$ pkgx mash pkgx/stub git
@@ -335,14 +325,13 @@ exec pkgx git "$@"
335325
336326& nbsp;
337327
338-
339328# Contributing
340329
341330We recommend using [` dev` ] to make rust available.
342331
343- * To add packages see the [pantry README]
344- * To hack on ` pkgx` itself; clone it and ` cargo build`
345- * [` hydrate.rs` ] is where optimization efforts will bear most fruit
332+ - To add packages see the [pantry README]
333+ - To hack on ` pkgx` itself; clone it and ` cargo build`
334+ - [` hydrate.rs` ] is where optimization efforts will bear most fruit
346335
347336# # Pre-PR Linting
348337
@@ -354,13 +343,12 @@ pkgx npx markdownlint --config .github/markdownlint.yml --fix .
354343
355344& nbsp;
356345
357-
358346# Chat / Support / Questions
359347
360348We love a good chinwag.
361349
362- * [Discord](https://discord.gg/rNwNUY83XS)
363- * [github.com/orgs/pkgxdev/discussions][discussions]
350+ - [Discord](https://discord.gg/rNwNUY83XS)
351+ - [github.com/orgs/pkgxdev/discussions][discussions]
364352
365353[docs]: https://docs.pkgx.sh
366354[pantry README]: ../../../pantry#contributing
@@ -375,7 +363,6 @@ We love a good chinwag.
375363[` dev` ]: https://github.com/pkgxdev/dev
376364[` pkgo` ]: https://github.com/pkgxdev/pkgo
377365[“Stable Diffusion WebUI”]: https://github.com/AUTOMATIC1111/stable-diffusion-webui
378-
379366[coverage]: https://coveralls.io/repos/github/pkgxdev/pkgx/badge.svg? branch=main
380367[coveralls]: https://coveralls.io/github/pkgxdev/pkgx? branch=main
381368[teaRank]: https://img.shields.io/endpoint? url=https%3A%2F%2Fchai.tea.xyz%2Fv1%2FgetTeaRankBadge%3FprojectId%3D79e9363b-862c-43e0-841d-4d4eaad1fc95
0 commit comments