pxxl-cli

v1.0.54

Published

4 months ago

Official CLI for pxxl.app cloud deployment platform - Deploy web applications instantly with zero configuration, automatic scaling, and enterprise-grade hosting.

0High
0Medium
0Low

pxxl-app

pxxl hosting deployment cli

Pxxl CLI Documentation

A comprehensive command-line interface for deploying and managing projects on pxxl.app hosting platform.

Installation
Quick Start
Commands Overview
Command Reference
Workflow Examples
Configuration Files

Installation

npm install -g pxxl-cli

Quick Start

Authenticate with pxxl.app
```
pxxl auth
```
Initialize your project
```
pxxl launch
```
Deploy your project
```
pxxl ship
```

Commands Overview

| Command | Alias | Description | |---------|-------|-------------| | pxxl auth | - | Authenticate with pxxl.app and save API key | | pxxl launch | init | Initialize a new project or link to existing one | | pxxl ship | deploy | Deploy your project to pxxl.app | | pxxl update | - | Update project configuration with current detection | | pxxl env | updateenv | Update environment variables for your project | | pxxl delete | - | Delete your project from pxxl.app servers | | pxxl standby | - | Put your project in maintenance/standby mode | | pxxl relaunch | - | Relaunch a previous deployment | | pxxl refresh | - | Refresh project configuration from pxxl.app | | pxxl deployments | - | List all deployments for the current project | | pxxl logs | - | Fetch build logs for the current project | | pxxl stats | - | View user statistics and usage data |

Command Reference

pxxl auth

Authenticate with pxxl.app and save your API key locally.

Usage:

pxxl auth

Interactive Flow:

Scenario 1: First-time authentication

🔐 Authenticate with pxxl.app
Please visit https://pxxl.app/dashboard/
api to get your API key

? Enter your API key: [hidden]
✅ Authentication successful! Welcome, 
John Doe

Scenario 2: Already authenticated

🔐 Authenticate with pxxl.app
✅ You are already logged in as John Doe
? What would you like to do?
  ❯ Continue with current account
    Logout and setup again
    Cancel

Scenario 3: Invalid API key

🔐 Authenticate with pxxl.app
? Enter your API key: [hidden]
❌ Omo! Authentication failed
API Key not found
? Would you like to try again? (Y/n)

Prerequisites: None Creates: ~/.pxxl/config.json with API key and user info

pxxl launch

Initialize a new pxxl.app project or link to an existing one. This command detects your project type and creates the necessary configuration.

Usage:

pxxl launch

Interactive Flow:

Scenario 1: New project initialization

🚀 Initialize new pxxl.app project

🔍 Environment files detected:
  .env
  .env.local

? Select environment file to use:
  ❯ No environment file
    .env
    .env.local

⠋ Detecting project...
🔍 Project detected:
  Framework: React
  Language: javascript
  Runtime: node
  TypeScript: Yes
  Build Pack: nodejs
  Install: npm install
  Build: npm run build
  Start: npm start

? Continue with detected settings? (Y/n)

? Enter project name: my-awesome-app
? Enter project description: My awesome 
React application

🔍 Available TLDs: .pxxl.pro, .pxxl.live, .pxxl.click
? Select TLD: .pxxl.pro
? Enter domain name (without TLD): 
my-awesome-app
⠋ Checking domain availability...
✅ Domain my-awesome-app.pxxl.pro is available!

? Port number: (3000)

✅ Project initialized successfully!
📁 Configuration saved to pxxl-config.json
🌐 Domain: my-awesome-app.pxxl.pro
🆔 Build ID: abc123def456

Scenario 2: Already initialized project

🚀 Initialize new pxxl.app project

✅ Config files found - project already 
linked
💡 To update project configuration, use: 
pxxl update

Scenario 3: Python project with requirements

🔍 Requirements files detected:
  requirements.txt
  requirements-dev.txt

? Select requirements file to use:
  ❯ requirements.txt
    requirements-dev.txt
    Not here - I will specify manually

🔍 Python files detected:
  app.py
  main.py

? Select entry file:
  ❯ app.py
    main.py
    Not here - I will specify manually

Prerequisites: pxxl auth must be completed Creates: pxxl-config.json in project root Port Validation: Must be between 1000-65535, port 200 is forbidden

pxxl ship

Deploy your project to pxxl.app. This command packages your project, uploads it, and triggers the deployment process.

Usage:

pxxl ship

Interactive Flow:

Scenario 1: Successful deployment

🚀 Starting deployment process...

⠋ Copying project files...
⠋ Compressing files...
⠋ Uploading to server...
⠋ Deploying project...

🎉 Project updated and deployed 
successfully!
📋 View your build logs in real time: 
https://pxxl.app/logs/abc123def456

Scenario 2: Deployment failure

🚀 Starting deployment process...

⠋ Copying project files...
⠋ Compressing files...
⠋ Uploading to server...
❌ Deployment failed
Error: Build failed - missing dependencies

Prerequisites:

pxxl auth completed
pxxl launch completed
Valid pxxl-config.json with buildId Process:

Cleans .pxxl directory
Copies project files (respects .gitignore )
Compresses files using gzip
Uploads to pxxl.app servers
Triggers deployment
Cleans up temporary files

pxxl update

Update project configuration with current project detection. Useful when you've made changes to your project structure.

Usage:

pxxl update

Interactive Flow:

Scenario 1: Update with new detection

🔄 Update pxxl.app project configuration

🔍 Found existing project: my-awesome-app
  Build ID: abc123def456
  Domain: my-awesome-app.pxxl.pro

⠋ Re-detecting project...
🔍 Updated project detection:
  Framework: Next.js
  Language: typescript
  Runtime: node
  TypeScript: Yes
  Build Pack: nodejs
  Install: npm install
  Build: npm run build
  Start: npm start

? Update configuration with detected 
settings? (Y/n)

✅ Project configuration updated 
successfully!

Scenario 2: Manual configuration

? Update configuration with detected 
settings? (n)

? Framework: Next.js
? Language: typescript
? Runtime Environment: node
? Install command: npm install
? Build command: npm run build
? Start command: npm start
? Port number: (3000)

Prerequisites:

pxxl auth completed
pxxl launch completed
Valid pxxl-config.json exists Port Validation: Must be between 1000-65535, port 200 is forbidden

pxxl env

Update environment variables for your project. This command allows you to upload and manage environment files for your deployed application.

Usage:

pxxl env
pxxl updateenv  # alias

Interactive Flow:

Scenario 1: Environment file selection

🌍 Update environment variables

🔍 Environment files detected:
  .env
  .env.production
  .env.local

? Select environment file to upload:
  ❯ .env
    .env.production
    .env.local
    Browse for file...
    Skip - no environment file

⠋ Uploading environment variables...
✅ Environment variables updated successfully!
🔄 Your application will restart with new environment variables

Scenario 2: No environment files found

🌍 Update environment variables

⚠️  No environment files detected in current directory

? What would you like to do?
  ❯ Browse for environment file
    Create new .env file
    Skip environment update
    Cancel

Scenario 3: Manual file selection

? Browse for environment file: /path/to/custom/.env

📋 Environment file contents preview:
DATABASE_URL=postgresql://...
API_KEY=sk-...
NODE_ENV=production

? Upload this environment file? (Y/n)

⠋ Uploading environment variables...
✅ Environment variables updated successfully!

Prerequisites:

pxxl auth completed
pxxl launch completed
Valid pxxl-config.json with buildId

Security Note: Environment files are encrypted during transmission and storage.

pxxl delete

Permanently delete your project from pxxl.app servers. This action cannot be undone.

Usage:

pxxl delete

Interactive Flow:

Scenario 1: Confirmation and countdown

🗑️  Delete project from pxxl.app

⚠️  WARNING: This will permanently delete your project!
📋 Project: my-awesome-app
🌐 Domain: my-awesome-app.pxxl.pro
🆔 Build ID: abc123def456

? Are you sure you want to delete this project? (y/N)

⏰ Deletion will proceed in 5 seconds...
   Press any key to cancel

⏰ 4...
⏰ 3...
⏰ 2...
⏰ 1...

⠋ Deleting project from server...
✅ Project deleted successfully!
🗑️  Local configuration file removed

Scenario 2: Cancelled deletion

⏰ Deletion will proceed in 3 seconds...
   Press any key to cancel

❌ Deletion cancelled by user
💡 Your project remains safe and deployed

Scenario 3: Deletion failure

⠋ Deleting project from server...
❌ Failed to delete project
Error: Project not found or already deleted

? Remove local configuration file anyway? (Y/n)

Prerequisites:

pxxl auth completed
pxxl launch completed
Valid pxxl-config.json with buildId

Warning: This action permanently removes your project, domain, and all associated data.

pxxl standby

Put your project in maintenance/standby mode. Useful for scheduled maintenance or temporary service suspension.

Usage:

pxxl standby

Interactive Flow:

Scenario 1: Enable standby mode

⏸️  Project standby management

📋 Current project: my-awesome-app
🌐 Domain: my-awesome-app.pxxl.pro
📊 Status: Active

? What would you like to do?
  ❯ Enable standby mode
    Check current status
    Cancel

⚠️  Enabling standby mode will:
  • Display maintenance page to visitors
  • Stop your application temporarily
  • Preserve all data and configuration

? Continue with standby mode? (Y/n)

⠋ Enabling standby mode...
✅ Standby mode enabled successfully!
🔧 Maintenance page is now active
💡 Use 'pxxl relaunch' to restore service

Scenario 2: Already in standby

⏸️  Project standby management

📋 Current project: my-awesome-app
🌐 Domain: my-awesome-app.pxxl.pro
📊 Status: Standby Mode

✅ Project is already in standby mode
🔧 Maintenance page is currently active

? What would you like to do?
  ❯ Disable standby mode (relaunch)
    Keep in standby mode
    Cancel

Scenario 3: Custom maintenance message

? Enter custom maintenance message (optional):
  We're performing scheduled maintenance. 
  Service will be restored shortly.

⠋ Enabling standby mode with custom message...
✅ Standby mode enabled with custom message!

Prerequisites:

pxxl auth completed
pxxl launch completed
Valid pxxl-config.json with buildId

Note: Standby mode preserves your application state and can be quickly reversed.

pxxl relaunch

Relaunch a previous deployment. This re-packages and re-deploys your current project state.

Usage:

pxxl relaunch

Interactive Flow:

Scenario 1: Successful relaunch

🔄 Starting relaunch process...

⠋ Relaunching...
⠋ Copying project files...
⠋ Compressing files...
⠋ Uploading to server...
⠋ Relaunching project...

✅ Project relaunched successfully!
📊 View deployment logs: https://pxxl.app/
logs/abc123def456

Prerequisites:

pxxl auth completed
pxxl launch completed
Valid pxxl-config.json with buildId

pxxl refresh

Refresh project configuration from pxxl.app servers. Syncs your local config with the server state.

Usage:

pxxl refresh

Interactive Flow:

Scenario 1: Successful refresh

🔄 Refreshing pxxl.app project

⠋ Refreshing application...
✅ Application refreshed successfully!
📝 Project configuration synchronized 
with server

Scenario 2: Refresh failure

🔄 Refreshing pxxl.app project

❌ Failed to refresh application
Error: Project not found on server

Prerequisites:

pxxl auth completed
pxxl launch completed
Valid pxxl-config.json with buildId

pxxl deployments

List all deployments for the current project with their status and details.

Usage:

pxxl deployments

Interactive Flow:

Scenario 1: Deployments found

⠋ Fetching project deployments...
✅ Deployments retrieved successfully!

🚀 Deployments (3):

┌─────────────────────────────────────────
─────────┐
│ 🆔 Deployment ID: 
dep_abc123def456                │
│ 🔨 Build Status: ✅ 
completed                     │
│ 🚀 Deployment Status: ✅ 
deployed                 │
│ 🌐 URL: https://my-awesome-app.
app                │
│ 📅 Created: 2025-08-15 
10:30:25                   │
└─────────────────────────────────────────
─────────┘

┌─────────────────────────────────────────
─────────┐
│ 🆔 Deployment ID: 
dep_def456ghi789                │
│ 🔨 Build Status: ❌ 
failed                        │
│ 🚀 Deployment Status: ⏸️ 
stopped                  │
│ 🌐 URL: Not 
available                             │
│ 📅 Created: 2025-08-14 
15:22:10                   │
└─────────────────────────────────────────
─────────┘

Scenario 2: No deployments

⠋ Fetching project deployments...
✅ Deployments retrieved successfully!

⚠️  No deployments found for this project.

Prerequisites:

pxxl auth completed
pxxl launch completed
Valid pxxl-config.json with buildId

pxxl logs

Fetch build logs for the current project. Useful for debugging deployment issues.

Usage:

pxxl logs [options]

Options:

-l, --lines - Number of log lines to fetch (default: 100) Examples:

pxxl logs              # Fetch last 100 
lines
pxxl logs -l 50        # Fetch last 50 
lines
pxxl logs --lines 200  # Fetch last 200 
lines

Interactive Flow:

Scenario 1: Logs available

⠋ Fetching build logs (100 lines)...
✅ Build logs retrieved successfully!

📋 Build Logs for abc123def456:
──────────────────────────────────────────
──────────────────
[2025-01-15 10:30:25] Starting build 
process...
[2025-01-15 10:30:26] Installing 
dependencies...
[2025-01-15 10:30:45] Running npm 
install...
[2025-01-15 10:31:20] Dependencies 
installed successfully
[2025-01-15 10:31:21] Running build 
command: npm run build
[2025-01-15 10:31:55] Build completed 
successfully
[2025-01-15 10:31:56] Deployment ready
──────────────────────────────────────────
──────────────────
Showing 100 lines | Application ID: 
app_xyz789

Scenario 2: No logs available

⠋ Fetching build logs (100 lines)...
✅ Build logs retrieved successfully!

📋 Build Logs for abc123def456:
──────────────────────────────────────────
──────────────────
No logs available for this build.
──────────────────────────────────────────
──────────────────
Showing 0 lines | Application ID: 
app_xyz789

Prerequisites:

pxxl auth completed
pxxl launch completed
Valid pxxl-config.json with buildId

pxxl stats

View user statistics and usage data including subscription details and resource usage.

Usage:

pxxl stats

Interactive Flow:

Scenario 1: Statistics retrieved

⠋ Fetching user statistics...
✅ Statistics retrieved successfully!

👤 User Information:
   Name: johndoe
   Email: [email protected]
   Member since: 1/10/2025

💳 Subscription:
   Plan: Pro
   Price: $29
   Projects limit: 10

📊 Usage:
   Total projects: 3
   Total databases: 2
   Build minutes used: 45/1000
   Build minutes left: 955

Prerequisites:

pxxl auth completed
Valid API key

Workflow Examples

Complete First-Time Setup

# 1. Install CLI globally
npm install -g pxxl-cli

# 2. Authenticate
pxxl auth
# Follow prompts to enter API key

# 3. Navigate to your project
cd my-project

# 4. Initialize project
pxxl launch
# Follow prompts for project configuration

# 5. Deploy
pxxl ship
# Wait for deployment to complete

# 6. Check deployment status
pxxl deployments

# 7. View logs if needed
pxxl logs

Update and Redeploy Workflow

# 1. Make changes to your project
# ... edit files ...

# 2. Update configuration if project structure changed
pxxl update

# 3. Deploy changes
pxxl ship

# 4. Monitor deployment
pxxl logs -l 50

Environment Management Workflow

# 1. Update environment variables
pxxl env
# Select and upload environment file

# 2. Verify deployment with new environment
pxxl logs

# 3. Test application functionality
# ... test your app ...

# 4. Rollback if needed
pxxl relaunch

Maintenance Workflow

# 1. Enable maintenance mode
pxxl standby
# Application shows maintenance page

# 2. Perform maintenance tasks
# ... update code, database, etc ...

# 3. Deploy updates
pxxl ship

# 4. Disable maintenance mode
pxxl relaunch
# Application is back online

Project Cleanup Workflow

# 1. Backup important data
# ... export databases, files, etc ...

# 2. Put project in standby (optional)
pxxl standby

# 3. Delete project permanently
pxxl delete
# Confirm deletion and wait for countdown

# 4. Verify local cleanup
# Check that pxxl-config.json is removed

Troubleshooting Workflow

# 1. Check deployment status
pxxl deployments

# 2. View recent logs
pxxl logs -l 200

# 3. Refresh configuration
pxxl refresh

# 4. Try relaunch if needed
pxxl relaunch

# 5. Check user stats for resource limits
pxxl stats

# 6. Enable standby mode if issues persist
pxxl standby

Advanced Workflows

Blue-Green Deployment Simulation

# 1. Enable standby mode (maintenance)
pxxl standby

# 2. Deploy new version
pxxl ship

# 3. Test deployment
pxxl logs

# 4. Restore service
pxxl relaunch

Environment-Specific Deployments

# Development environment
pxxl env  # Upload .env.development
pxxl ship

# Production environment
pxxl env  # Upload .env.production
pxxl ship

Configuration Files

Global Configuration (~/.pxxl/config.json)

Stores user authentication data:

{
  "apiKey": "your-api-key-here",
  "userFullName": "John Doe"
}

Project Configuration (pxxl-config.json)

Stores project-specific settings:

{
  "name": "my-awesome-app",
  "description": "My awesome React 
  application",
  "domain": "my-awesome-app.pxxl.pro",
  "buildId": "abc123def456",
  "apiKey": "your-api-key-here",
  "framework": "React",
  "frameworkAlias": "React",
  "language": "javascript",
  "runtimeEnvironment": "node",
  "buildCommand": "npm run build",
  "installCommand": "npm install",
  "startCommand": "npm start",
  "buildPack": "nodejs",
  "isTypescript": true,
  "port": 3000,
  "envFile": ".env",
  "requirementsDir": null,
  "entryFile": null,
  "nodeVersion": "22",
  "isLinked": true
}

Supported Project Types

| Project Type | Frameworks/Libraries | Build Pack | Runtime | |--------------|---------------------|------------|----------| | Node.js | React, Next.js, Vue.js, Express, Nuxt.js, Svelte | nodejs | node | | Python | Flask, Django, FastAPI, Streamlit, Bottle | python | python | | Static Sites | HTML/CSS/JS, Gatsby, Jekyll, Hugo | static | - | | TypeScript | Any TS-based framework | nodejs | node | | PHP | Laravel, Symfony, CodeIgniter | php | php | | Go | Gin, Echo, Fiber | go | go | | Rust | Actix, Rocket, Warp | rust | rust |

Port Configuration

| Port Range | Status | Usage | |------------|--------|-------| | 1000-65535 | ✅ Allowed | Standard application ports | | 200 | ❌ Forbidden | Reserved for system use | | 1-999 | ❌ Forbidden | System reserved ports | | 80, 443 | ⚠️ Managed | Handled by pxxl.app proxy |

Environment File Support

| File Name | Priority | Description | |-----------|----------|-------------| | .env | High | Standard environment file | | .env.local | High | Local development overrides | | .env.production | Medium | Production-specific variables | | .env.development | Medium | Development-specific variables | | .env.staging | Medium | Staging environment variables | | custom.env | Low | Custom named environment files |

File Exclusions

The CLI automatically excludes common files and directories during deployment:

| Category | Files/Directories | Reason | |----------|------------------|--------| | Dependencies | node_modules/, vendor/, __pycache__/ | Large, regenerable | | Version Control | .git/, .svn/, .hg/ | Not needed in production | | Build Artifacts | dist/, build/, target/ | Generated during build | | IDE Files | .vscode/, .idea/, *.swp | Development-specific | | OS Files | .DS_Store, Thumbs.db, desktop.ini | System-generated | | Logs | *.log, logs/, npm-debug.log* | Runtime artifacts | | Environment | .env.local, .env.*.local | Local overrides | | Cache | .cache/, .tmp/, temp/ | Temporary files | | Custom | Files listed in .gitignore | User-defined exclusions |

Command Status Codes

| Exit Code | Status | Description | |-----------|--------|-------------| | 0 | ✅ Success | Command completed successfully | | 1 | ❌ General Error | Generic failure | | 2 | ❌ Authentication | API key invalid or missing | | 3 | ❌ Configuration | Missing or invalid config files | | 4 | ❌ Network | Connection or upload failure | | 5 | ❌ Validation | Invalid input or parameters | | 6 | ❌ Permission | Insufficient permissions | | 130 | ⚠️ Interrupted | User cancelled operation |

Error Handling & Troubleshooting

Common Error Messages

| Error Message | Cause | Solution | |---------------|-------|----------| | API Key not found | Missing or invalid API key | Run pxxl auth to authenticate | | Project not initialized | No pxxl-config.json found | Run pxxl launch to initialize | | Build failed | Compilation/build errors | Check pxxl logs for details | | Domain already taken | Domain name unavailable | Choose different domain name | | Upload failed | Network or file issues | Check internet connection, retry | | Port 200 is forbidden | Invalid port number | Use ports 1000-65535 | | Project not found | Invalid build ID | Refresh config with pxxl refresh | | Insufficient permissions | Account limitations | Check pxxl stats for limits |

Debugging Steps

Check Authentication
```
pxxl auth  # Verify API key is valid
```

Verify Configuration

cat pxxl-config.json  # Check config file
pxxl refresh          # Sync with server

Review Logs

pxxl logs -l 200      # Get detailed logs
pxxl deployments      # Check deployment status

Test Connectivity

pxxl stats            # Test API connection

Clean Rebuild

pxxl update           # Update configuration
pxxl ship             # Fresh deployment

Performance Optimization

| Optimization | Command | Benefit | |--------------|---------|----------| | Exclude Large Files | Add to .gitignore | Faster uploads | | Minimize Dependencies | Remove unused packages | Smaller bundle | | Use Build Cache | Proper build commands | Faster builds | | Optimize Images | Compress before upload | Reduced size | | Environment Variables | Use pxxl env | Secure config |

API Reference

Global Configuration

Location: ~/.pxxl/config.json

{
  "apiKey": "string",
  "userFullName": "string"
}

Project Configuration

Location: ./pxxl-config.json

{
  "name": "string",
  "description": "string",
  "domain": "string",
  "buildId": "string",
  "apiKey": "string",
  "framework": "string",
  "frameworkAlias": "string",
  "language": "string",
  "runtimeEnvironment": "string",
  "buildCommand": "string",
  "installCommand": "string",
  "startCommand": "string",
  "buildPack": "string",
  "isTypescript": "boolean",
  "port": "number",
  "envFile": "string|null",
  "requirementsDir": "string|null",
  "entryFile": "string|null",
  "nodeVersion": "string",
  "isLinked": "boolean"
}

Configuration Field Descriptions

| Field | Type | Required | Description | |-------|------|----------|-------------| | name | string | ✅ | Project name (alphanumeric, hyphens) | | description | string | ❌ | Project description | | domain | string | ✅ | Full domain (name + TLD) | | buildId | string | ✅ | Unique project identifier | | framework | string | ✅ | Detected framework | | language | string | ✅ | Primary language (javascript, python, etc.) | | runtimeEnvironment | string | ✅ | Runtime (node, python, etc.) | | buildCommand | string | ✅ | Command to build project | | installCommand | string | ✅ | Command to install dependencies | | startCommand | string | ✅ | Command to start application | | port | number | ✅ | Application port (1000-65535) | | isTypescript | boolean | ✅ | TypeScript usage flag | | envFile | string | ❌ | Environment file path | | nodeVersion | string | ❌ | Node.js version (for Node projects) |

Security & Best Practices

Security Guidelines

| Practice | Description | Implementation | |----------|-------------|----------------| | API Key Protection | Never commit API keys | Use global config only | | Environment Variables | Secure sensitive data | Use pxxl env command | | Access Control | Limit project access | Use team features | | Regular Updates | Keep CLI updated | npm update -g pxxl-cli | | Backup Configs | Save important configs | Version control configs |

Best Practices

Project Organization
- Use descriptive project names
- Maintain consistent directory structure
- Document deployment processes
Environment Management
- Separate dev/staging/prod environments
- Use environment-specific configs
- Never hardcode sensitive values
Deployment Strategy
- Test locally before deployment
- Use staging environments
- Monitor deployment logs
- Implement rollback procedures
Monitoring & Maintenance
- Regular log reviews
- Performance monitoring
- Scheduled maintenance windows
- Backup strategies

CLI Command Comparison

| Feature | pxxl ship | pxxl relaunch | pxxl update | |---------|-------------|-----------------|---------------| | File Processing | ✅ Full | ✅ Full | ❌ Config only | | Compression | ✅ Yes | ✅ Yes | ❌ No | | Upload | ✅ Yes | ✅ Yes | ❌ No | | Build Trigger | ✅ Yes | ✅ Yes | ❌ No | | Config Update | ❌ No | ❌ No | ✅ Yes | | Use Case | New deployment | Re-deploy current | Update settings |

Frequently Asked Questions

General Questions

Q: What's the difference between pxxl ship and pxxl relaunch? A: Both deploy your project, but pxxl ship is for new deployments while pxxl relaunch re-deploys the current state.

Q: Can I use custom domains? A: Currently, pxxl.app provides subdomains (.pxxl.pro, .pxxl.live, .pxxl.click). Custom domains may be available in future updates.

Q: How do I change my project's domain? A: You'll need to delete and recreate the project with a new domain, as domains cannot be changed after creation.

Q: What happens to my data when I use pxxl delete? A: All project data, including files, databases, and configurations, are permanently deleted and cannot be recovered.

Technical Questions

Q: Why is port 200 forbidden? A: Port 200 is reserved for system use by pxxl.app infrastructure.

Q: Can I deploy multiple projects from the same directory? A: No, each directory can only contain one pxxl project configuration.

Q: How large can my project be? A: Check your account limits with pxxl stats. Limits vary by subscription plan.

Q: Can I use environment variables in my build commands? A: Yes, environment variables uploaded via pxxl env are available during build and runtime.

Support & Resources

Getting Help

| Resource | Description | Link | |----------|-------------|------| | 📧 Email Support | Direct technical support | [email protected] | | 🌐 Website | Main platform and dashboard | pxxl.app | | 📚 Documentation | Comprehensive guides | docs.pxxl.app | | 💬 Community | User discussions and tips | community.pxxl.app | | 🐛 Bug Reports | Report issues and bugs | github.com/pxxl/cli/issues | | 📋 Feature Requests | Suggest new features | feedback.pxxl.app |

Version Information

# Check CLI version
npm list -g pxxl-cli

# Update to latest version
npm update -g pxxl-cli

# Install specific version
npm install -g [email protected]

Contributing

We welcome contributions to improve the pxxl CLI:

Report Issues: Use GitHub issues for bugs
Feature Requests: Submit via feedback portal
Documentation: Help improve these docs
Testing: Test beta features and provide feedback

Developed and maintained by the Pxxl team.

Last updated: 5 Sept 2025

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

Pxxl CLI Documentation

Table of Contents

Installation

Quick Start

Commands Overview

Command Reference

pxxl auth

pxxl launch

pxxl ship

pxxl update

pxxl env

pxxl delete

pxxl standby

pxxl relaunch

pxxl refresh

pxxl deployments

pxxl logs

pxxl stats

Workflow Examples

Complete First-Time Setup

Update and Redeploy Workflow

Environment Management Workflow

Maintenance Workflow

Project Cleanup Workflow

Troubleshooting Workflow

Advanced Workflows

Blue-Green Deployment Simulation

Environment-Specific Deployments

Configuration Files

Global Configuration (~/.pxxl/config.json)

Project Configuration (pxxl-config.json)

Supported Project Types

Port Configuration

Environment File Support

File Exclusions

Command Status Codes

Error Handling & Troubleshooting

Common Error Messages

Debugging Steps

Performance Optimization

API Reference

Global Configuration

Project Configuration

Configuration Field Descriptions

Security & Best Practices

Security Guidelines

Best Practices

CLI Command Comparison

Frequently Asked Questions

General Questions

Technical Questions

Support & Resources

Getting Help

Version Information

Contributing