LogoLogo
HomeAPIBlog
3.0.0-SNAPSHOT
3.0.0-SNAPSHOT
  • INTRODUCTION
    • Getting Started
      • Running Local Development Servers
      • Beginner Tutorial: Hello World
      • Beginner Tutorial: Hello Database
      • Tutorial: Wheels, AJAX, and You
    • Frameworks and Wheels
    • Requirements
    • Manual Installation
    • Upgrading
    • Screencasts
  • Command Line Tools
    • CLI Overview
    • Quick Start Guide
    • Command Reference
      • Core Commands
        • wheels init
        • wheels info
        • wheels reload
        • wheels deps
        • wheels destroy
        • wheels watch
      • Code Generation
        • wheels generate app
        • wheels generate app-wizard
        • wheels generate controller
        • wheels generate model
        • wheels generate view
        • wheels generate property
        • wheels generate route
        • wheels generate resource
        • wheels generate api-resource
        • wheels generate frontend
        • wheels generate test
        • wheels generate snippets
        • wheels scaffold
      • Database Commands
        • wheels dbmigrate info
        • wheels dbmigrate latest
        • wheels dbmigrate up
        • wheels dbmigrate down
        • wheels dbmigrate reset
        • wheels dbmigrate exec
        • wheels dbmigrate create blank
        • wheels dbmigrate create table
        • wheels dbmigrate create column
        • wheels dbmigrate remove table
        • wheels db schema
        • wheels db seed
      • Testing Commands
        • wheels test
        • wheels test run
        • wheels test coverage
        • wheels test debug
      • Configuration Commands
        • wheels config list
        • wheels config set
        • wheels config env
      • Environment Management
        • wheels env
        • wheels env setup
        • wheels env list
        • wheels env switch
      • Plugin Management
        • wheels plugins
        • wheels plugins list
        • wheels plugins install
        • wheels plugins remove
      • Code Analysis
        • wheels analyze
        • wheels analyze code
        • wheels analyze performance
        • wheels analyze security
      • Security Commands
        • wheels security
        • wheels security scan
      • Performance Commands
        • wheels optimize
        • wheels optimize performance
      • Documentation Commands
        • wheels docs
        • wheels docs generate
        • wheels docs serve
      • CI/CD Commands
        • wheels ci init
      • Docker Commands
        • wheels docker init
        • wheels docker deploy
      • Deployment Commands
        • wheels deploy
        • wheels deploy audit
        • wheels deploy exec
        • wheels deploy hooks
        • wheels deploy init
        • wheels deploy lock
        • wheels deploy logs
        • wheels deploy proxy
        • wheels deploy push
        • wheels deploy rollback
        • wheels deploy secrets
        • wheels deploy setup
        • wheels deploy status
        • wheels deploy stop
    • CLI Development Guides
      • Creating Commands
      • Service Architecture
      • Migrations Guide
      • Testing Guide
  • Working with Wheels
    • Conventions
    • Configuration and Defaults
    • Directory Structure
    • Switching Environments
    • Testing Your Application
    • Using the Test Environment
    • Contributing to Wheels
    • Submitting Pull Requests
    • Documenting your Code
  • Handling Requests with Controllers
    • Request Handling
    • Rendering Content
    • Redirecting Users
    • Sending Files
    • Sending Email
    • Responding with Multiple Formats
    • Using the Flash
    • Using Filters
    • Verification
    • Event Handlers
    • Routing
    • URL Rewriting
      • Apache
      • IIS
      • Tomcat
      • Nginx
    • Obfuscating URLs
    • Caching
    • Nesting Controllers
    • CORS Requests
  • Displaying Views to Users
    • Pages
    • Partials
    • Linking Pages
    • Layouts
    • Form Helpers and Showing Errors
    • Displaying Links for Pagination
    • Date, Media, and Text Helpers
    • Creating Custom View Helpers
    • Localization
  • Database Interaction Through Models
    • Object Relational Mapping
    • Creating Records
    • Reading Records
    • Updating Records
    • Deleting Records
    • Column Statistics
    • Dynamic Finders
    • Getting Paginated Data
    • Associations
    • Nested Properties
    • Object Validation
    • Object Callbacks
    • Calculated Properties
    • Transactions
    • Dirty Records
    • Soft Delete
    • Automatic Time Stamps
    • Database Migrations
      • Migrations in Production
    • Using Multiple Data Sources
  • Plugins
    • Installing and Using Plugins
    • Developing Plugins
    • Publishing Plugins
  • Project Documentation
    • Overview
  • External Links
    • Source Code
    • Issue Tracker
    • Sponsor Us
    • Community
Powered by GitBook
LogoLogo
On this page
  • Synopsis
  • Description
  • Options
  • Examples
  • Basic push
  • Push specific artifact
  • Dry run to see what would be pushed
  • Push with exclusions
  • Limited bandwidth push
  • Artifact Types
  • Application bundles
  • Docker images
  • Static assets
  • Configuration files
  • Push Process
  • Use Cases
  • CI/CD pipeline push
  • Multi-environment push
  • Incremental push
  • Secure push with encryption
  • Transfer Methods
  • Direct transfer
  • S3 bucket transfer
  • Registry push
  • Validation
  • Pre-push validation
  • Post-push validation
  • Progress Monitoring
  • Error Handling
  • Retry failed pushes
  • Resume interrupted push
  • Rollback on failure
  • Best Practices
  • Configuration
  • .deployignore file
  • Push configuration
  • Integration
  • See Also

Was this helpful?

Edit on GitHub
Export as PDF
  1. Command Line Tools
  2. Command Reference
  3. Deployment Commands

wheels deploy push

Push deployment artifacts to target environment.

Synopsis

wheels deploy push [options]

Description

The wheels deploy push command transfers deployment artifacts, configuration files, and application code to the target deployment environment. It handles file synchronization, artifact validation, and ensures secure transfer of deployment packages.

Options

  • --environment, -e - Target environment (default: production)

  • --artifact - Path to deployment artifact or directory

  • --config - Configuration file to include

  • --exclude - Files/patterns to exclude from deployment

  • --dry-run - Simulate push without actual transfer

  • --force - Force push even if validation fails

  • --parallel - Number of parallel upload threads

  • --compress - Compression method (gzip, bzip2, none)

  • --checksum - Verify file integrity with checksums

  • --bandwidth - Limit bandwidth usage (e.g., "1M", "500K")

Examples

Basic push

wheels deploy push --environment production

Push specific artifact

wheels deploy push --artifact dist/app-v2.1.0.tar.gz

Dry run to see what would be pushed

wheels deploy push --dry-run

Push with exclusions

wheels deploy push --exclude "*.log,tmp/*,node_modules"

Limited bandwidth push

wheels deploy push --bandwidth 1M

Artifact Types

Application bundles

# Push application bundle
wheels deploy push --artifact app-bundle.tar.gz

Docker images

# Push Docker image
wheels deploy push --artifact myapp:v2.1.0 --type docker

Static assets

# Push static files
wheels deploy push --artifact public/ --compress gzip

Configuration files

# Push config separately
wheels deploy push --config production.env --encrypt

Push Process

  1. Validation: Verify artifacts and environment

  2. Compression: Compress files if specified

  3. Checksum: Generate integrity checksums

  4. Transfer: Upload to target environment

  5. Verification: Confirm successful transfer

  6. Notification: Report push status

Use Cases

CI/CD pipeline push

# Build and push in CI/CD
npm run build
wheels deploy push --artifact dist/ --environment staging

Multi-environment push

# Push to multiple environments
for env in staging production; do
  wheels deploy push --environment $env --artifact release.tar.gz
done

Incremental push

# Push only changed files
wheels deploy push --incremental --since "1 hour ago"

Secure push with encryption

# Encrypt sensitive files during push
wheels deploy push \
  --artifact app.tar.gz \
  --config secrets.env \
  --encrypt

Transfer Methods

Direct transfer

Default method for simple deployments:

wheels deploy push --method direct

S3 bucket transfer

For AWS deployments:

wheels deploy push \
  --method s3 \
  --bucket my-deploy-bucket \
  --artifact app.tar.gz

Registry push

For containerized applications:

wheels deploy push \
  --method registry \
  --registry hub.example.com \
  --artifact myapp:latest

Validation

The push command performs several validations:

Pre-push validation

  • Artifact integrity check

  • Environment accessibility

  • Space availability

  • Permission verification

Post-push validation

  • Transfer completion

  • Checksum verification

  • Artifact extraction test

  • Configuration validation

Progress Monitoring

# Show detailed progress
wheels deploy push --verbose

# Output example:
Uploading app-v2.1.0.tar.gz to production
[████████████████████████████████] 100% 45.2MB/45.2MB
✓ Upload complete
✓ Checksum verified
✓ Artifact validated

Error Handling

Retry failed pushes

# Auto-retry on failure
wheels deploy push --retry 3 --retry-delay 30

Resume interrupted push

# Resume from last checkpoint
wheels deploy push --resume

Rollback on failure

# Automatic rollback if push fails
wheels deploy push --rollback-on-failure

Best Practices

  1. Always validate: Use --dry-run before actual push

  2. Use checksums: Enable checksum verification

  3. Compress large artifacts: Reduce transfer time and bandwidth

  4. Exclude unnecessary files: Use .deployignore file

  5. Monitor transfer: Watch for errors during push

  6. Test in staging: Always push to staging before production

  7. Keep artifacts versioned: Use semantic versioning

Configuration

.deployignore file

# Files to exclude from deployment
*.log
*.tmp
.env.local
node_modules/
test/
docs/

Push configuration

# deploy.yml
push:
  compression: gzip
  checksum: sha256
  parallel: 4
  exclude:
    - "*.log"
    - "tmp/*"
  retry:
    attempts: 3
    delay: 30

Integration

Push operations integrate with:

  • CI/CD systems for automated deployments

  • Artifact repositories (Nexus, Artifactory)

  • Container registries (Docker Hub, ECR)

  • CDN services for static assets

  • Monitoring systems for transfer tracking

See Also

Previouswheels deploy proxyNextwheels deploy rollback

Last updated 2 days ago

Was this helpful?

- Execute deployment after push

- Check push status

- Rollback pushed artifacts

deploy exec
deploy status
deploy rollback