Skip to main content

Installation

This guide covers installing all Pixell components for different platforms and use cases.

System Requirements​

Minimum Requirements​

  • Node.js: 18.17.0 or higher
  • npm: 9.0.0 or higher (or yarn 1.22.0+)
  • Operating System: macOS, Linux, or Windows
  • Memory: 4GB RAM minimum, 8GB recommended
  • Storage: 2GB free space
  • Node.js: 20.x LTS
  • Memory: 16GB RAM
  • Storage: 10GB free space
  • Network: Stable internet connection for cloud features

Installation Methods​

Install the complete Pixell toolkit:

# Install PAK (Pixell Agent Kit) - CLI and SDK
npm install -g @pixell/pak

# Install PAR (Pixell Agent Runtime) - for local development
npm install -g @pixell/par

# Install PAC CLI (Pixell Agent Cloud) - for deployment
npm install -g @pixell/pac-cli

Method 2: Install Components Individually​

Install PAK Only (For Agent Development)​

npm install -g @pixell/pak

Install PAR Only (For Running Agents Locally)​

npm install -g @pixell/par

Install PAC CLI Only (For Cloud Deployment)​

npm install -g @pixell/pac-cli

Platform-Specific Instructions​

macOS​

# Install Node.js via Homebrew
brew install node

# Install Pixell tools
npm install -g @pixell/pak @pixell/par @pixell/pac-cli

Using Official Installer​

  1. Download Node.js from nodejs.org
  2. Run the installer
  3. Open Terminal and install Pixell tools:
npm install -g @pixell/pak @pixell/par @pixell/pac-cli

Linux (Ubuntu/Debian)​

# Update package list
sudo apt update

# Install Node.js
curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash -
sudo apt-get install -y nodejs

# Install Pixell tools
sudo npm install -g @pixell/pak @pixell/par @pixell/pac-cli

Linux (CentOS/RHEL/Fedora)​

# Install Node.js
curl -fsSL https://rpm.nodesource.com/setup_20.x | sudo bash -
sudo yum install -y nodejs

# Install Pixell tools
sudo npm install -g @pixell/pak @pixell/par @pixell/pac-cli

Windows​

# Install Node.js
choco install nodejs

# Install Pixell tools
npm install -g @pixell/pak @pixell/par @pixell/pac-cli

Using Official Installer​

  1. Download Node.js from nodejs.org
  2. Run the installer as Administrator
  3. Open PowerShell as Administrator and install:
npm install -g @pixell/pak @pixell/par @pixell/pac-cli

Docker Installation (Alternative)​

If you prefer using Docker:

# Pull the official Pixell image
docker pull pixell/pixell:latest

# Run PAK CLI
docker run -it --rm -v $(pwd):/workspace pixell/pixell pak --help

# Run PAR
docker run -it --rm -p 3000:3000 -v $(pwd):/agents pixell/pixell par

Verification​

Verify your installation:

# Check PAK installation
pak --version

# Check PAR installation
par --version

# Check PAC CLI installation
pac --version

# Check Node.js version
node --version

# Check npm version
npm --version

Expected output:

pak: 1.0.0
par: 1.0.0
pac: 1.0.0
node: v20.10.0
npm: 10.2.3

Development Dependencies​

For agent development, you may also want to install:

# TypeScript (for TypeScript agents)
npm install -g typescript

# ESLint (for code quality)
npm install -g eslint

# Prettier (for code formatting)
npm install -g prettier

Environment Variables​

Set up environment variables for cloud features:

# Add to your ~/.bashrc, ~/.zshrc, or ~/.profile
export PIXELL_API_KEY="your-api-key"
export PIXELL_REGION="us-east-1"
export PIXELL_DEBUG="false"

Troubleshooting​

Permission Errors (Linux/macOS)​

If you get permission errors, use sudo or configure npm to use a different directory:

# Option 1: Use sudo (not recommended for security)
sudo npm install -g @pixell/pak

# Option 2: Configure npm prefix (recommended)
mkdir ~/.npm-global
npm config set prefix '~/.npm-global'
echo 'export PATH=~/.npm-global/bin:$PATH' >> ~/.bashrc
source ~/.bashrc
npm install -g @pixell/pak

Windows PowerShell Execution Policy​

If you get execution policy errors on Windows:

# Run as Administrator
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser

Node.js Version Issues​

If you have multiple Node.js versions, use a version manager:

Using nvm (Linux/macOS)​

# Install nvm
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash

# Install and use Node.js 20
nvm install 20
nvm use 20

# Install Pixell tools
npm install -g @pixell/pak @pixell/par @pixell/pac-cli

Using nvm-windows​

# Install nvm-windows from https://github.com/coreybutler/nvm-windows
# Then:
nvm install 20.10.0
nvm use 20.10.0
npm install -g @pixell/pak @pixell/par @pixell/pac-cli

Uninstallation​

To remove Pixell tools:

# Remove all Pixell packages
npm uninstall -g @pixell/pak @pixell/par @pixell/pac-cli

# Clean npm cache
npm cache clean --force

Next Steps​

Getting Help​