Skip to main content

Quickstart

Get started with Pixell in 5 minutes. This guide will walk you through creating your first agent app and deploying it to the cloud.

Prerequisites​

  • Node.js 18.17.0 or higher
  • npm or yarn package manager
  • Basic familiarity with JavaScript/TypeScript

Step 1: Install PAK CLI​

Install the Pixell Agent Kit (PAK) CLI globally:

npm install -g @pixell/pak

Verify the installation:

pak --version

Step 2: Create Your First Agent​

Initialize a new agent project:

pak init my-first-agent
cd my-first-agent

This creates a basic agent structure with:

  • manifest.json - Agent configuration
  • agent/ - Agent logic code
  • ui/ - Frontend components
  • package.json - Dependencies

Step 3: Build the Agent Package​

Build your agent into an APKG (Agent Package) file:

pak build

This creates my-first-agent.apkg - a deployable agent package.

Step 4: Test Locally​

Run your agent locally to test it:

pak dev

Your agent will be available at http://localhost:3000

Step 5: Deploy to Cloud​

Deploy your agent to Pixell Agent Cloud (PAC):

pixell deploy my-first-agent.apkg

Your agent is now live and accessible via the cloud!

What's Next?​

Troubleshooting​

PAK command not found​

Make sure you installed PAK globally:

npm install -g @pixell/pak

Build fails​

Check that you're in the agent directory and have a valid manifest.json:

ls -la manifest.json

Deploy fails​

Ensure you have a valid APKG file:

ls -la *.apkg

Need Help?​