This library includes tools to fetch and save package information from pkgx.dev.
npm install ts-pkgx
bun install ts-pkgxThe library includes a CLI tool to fetch packages from pkgx.dev:
# Fetch a single package
bun run pkgx:fetch node
# With custom output directory
bun run pkgx:fetch node --output ./data/packages
# Fetch all packages
bun run pkgx:fetch-all
# Set a custom timeout (milliseconds)
bun run pkgx:fetch-all --timeout 180000 --output ./data/pkgx-packagesYou can also use the library programmatically in your code:
import { fetchAndSaveAllPackages, fetchPkgxPackage } from 'ts-pkgx'
// Fetch a single package
const nodePackage = await fetchPkgxPackage('node')
console.log(nodePackage)
// Fetch and save all packages
const savedPackages = await fetchAndSaveAllPackages({
timeout: 120000
})
console.log(`Saved ${savedPackages.length} packages`)ts-pkgx provides comprehensive TypeScript types for all packages in the pkgx.dev ecosystem, enabling you to work in a fully typed environment with extensive type safety features:
import type {
InstallationPlan, // Installation planning interface
PackageAlias, // All available package aliases (e.g., 'node', 'python')
PackageDomain, // All available package domains (e.g., 'nodejs.org')
PackageInfo, // Comprehensive package information
PackageName, // Union of all valid package identifiers
PackageSpec, // Package specifications with versions (e.g., 'node@20.1.0')
Pantry,
SupportedArchitecture, // 'x86_64' | 'aarch64' | 'armv7l' | 'i686'
SupportedPlatform // 'darwin' | 'linux' | 'windows'
} from 'ts-pkgx'
import {
aliases,
createInstallPlan,
getLatestVersion,
getPackageInfo,
isValidPackageName,
pantry,
resolvePackageName
} from 'ts-pkgx'
// Access packages with full type safety
const nodePackage = pantry.nodejs_org
const pythonPackage = pantry.python_org
const goPackage = pantry.go_dev
// Type-safe package operations
function installPackage(packageName: PackageName, version?: string) {
// TypeScript ensures only valid package names are accepted
const info = getPackageInfo(packageName)
const latest = getLatestVersion(packageName)
const plan = createInstallPlan(version ? `${packageName}@${version}` : packageName)
return { info, latest, plan }
}
// Type guards for runtime validation
if (isValidPackageName('node')) {
const resolution = resolvePackageName('node') // Type-safe resolution
}
// All package properties are fully typed
console.log(nodePackage.name) // string
console.log(nodePackage.programs) // readonly string[]
console.log(nodePackage.versions) // readonly string[]The type system includes:
- Comprehensive type safety: All package names, versions, and operations are type-checked
- Package name types: Union types for aliases, domains, and specifications
- Platform types: Support for different operating systems and architectures
- Version resolution: Type-safe version specification and resolution
- CLI utilities: Type-safe command operations with error handling
- Installation planning: Type-safe installation plan generation
- Auto-completion: Full IntelliSense support in your IDE
bun testbun testPlease see our releases page for information on changes.
Please see CONTRIBUTING for details.
For help or discussion:
"Software that is free, but hopes for a postcard." We love receiving postcards from around the world showing where Stacks is being used! We showcase them on our website too.
Our address: Stacks.js, 12665 Village Ln #2306, Playa Vista, CA 90094, United States 🌎
- Max Howell - for creating pkgx and Homebrew
- pkgm & dev - thanks for the inspiration
- Chris Breuer
- All Contributors
We would like to extend our thanks to the following sponsors for funding Stacks development. If you are interested in becoming a sponsor, please reach out to us.
The MIT License (MIT). Please see LICENSE for more information.
Made with 💙
