Installation

Installing ts-pkgx is easy. Simply pull it in via your package manager of choice.

Package Managers

Choose your package manager of choice:

npm

npm install ts-pkgx
# npm i ts-pkgx

# Or, as a development dependency
npm install --save-dev ts-pkgx

bun

bun install ts-pkgx
# bun add ts-pkgx

# Or, as a development dependency
bun install --dev ts-pkgx

pnpm

pnpm add ts-pkgx
# pnpm i ts-pkgx

# Or, as a development dependency
pnpm add --save-dev ts-pkgx

yarn

yarn add ts-pkgx
# yarn i ts-pkgx

# Or, as a development dependency
yarn add --dev ts-pkgx

Global Installation

If you want to use the CLI globally, you can install it globally:

npm

npm install -g ts-pkgx

bun

bun install -g ts-pkgx

pnpm

pnpm add -g ts-pkgx

yarn

yarn global add ts-pkgx

Using Pre-compiled Binaries

ts-pkgx also provides pre-compiled binaries for various platforms. These allow you to use the CLI without needing to install Node.js or Bun:

# Download the binary for your platform
curl -fsSL https://github.com/stacksjs/ts-pkgx/releases/latest/download/pkgx-tools-$(uname -s | tr '[:upper:]' '[:lower:]')-$(uname -m).zip -o pkgx-tools.zip

# Unzip the binary
unzip pkgx-tools.zip

# Make it executable
chmod +x pkgx-tools

# Move to a directory in your PATH (optional)
sudo mv pkgx-tools /usr/local/bin/

Verification

To verify the installation, you can run:

bun run pkgx:fetch node

Or if you installed globally or are using the binary:

pkgx-tools fetch node

This should fetch information about the Node.js package from pkgx.dev.

Requirements

ts-pkgx requires:

• Bun runtime

Next Steps

Once you have ts-pkgx installed, check out the Usage guide to learn how to use it.