pkgx

(โ˜… 9,901)

Run Anything

  • .envrc
  • .gitbook.yaml
  • .gitignore
  • AGENTS.md
  • Cargo.lock
  • Cargo.toml
  • LICENSE.txt
  • README.md
  • tea.yaml

# Installation Guide

1. Get the code
git clone https://github.com/pkgxdev/pkgx

Downloads the entire project code from GitHub to your computer.

cd pkgx

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Homebrew A package manager for macOS/Linux.
brew install pkgx || curl https://pkgx.sh | sh

Downloads and runs the official install script in one line โ€” this handles the full setup automatically.

irm https://pkgx.sh | iex

Downloads and runs the official install script via PowerShell โ€” this handles the full setup automatically.

curl https://pkgx.sh | sh

Downloads and runs the official install script in one line โ€” this handles the full setup automatically.

โœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
$ pkgx docker run -it pkgxdev/pkgx

Runs the built image as an actual container.

(docker) $ pkgx node@16

Type this command into your terminal and run it.

$ docker run pkgxdev/pkgx node@21.1 --version

Runs the built image as an actual container.

โœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

4. Rust

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Rust (rustup) Installing via rustup also installs cargo.
+cargo +rust

Type this command into your terminal and run it.

Cargo.toml src/

Type this command into your terminal and run it.

my-rust-proj $ cargo build

Compiles the Rust project.

command not found: cargo

Type this command into your terminal and run it.

+rust +cargo

Type this command into your terminal and run it.

โœ… If cargo build finishes without errors, it worked. The executable is created under target/.

Pulled directly from this repo's README.

// repository documentation