Commands

The PrestaShop Enterprise Developer Tools CLI provides comprehensive command-line functionality for managing your local development environment. This section contains detailed documentation for every available command.

Command Overview

The CLI supports two main operation modes:

  1. Automated Workflow: Run ps-enterprise without arguments for complete environment setup
  2. Individual Commands: Execute specific commands for targeted operations

Global Flags

All commands support these global flags that affect the entire workflow:

Flag Short Description Example
--help -h Show help information ps-enterprise --help
--clean -c Run clean command first ps-enterprise --clean
--force -f Force operations without confirmation ps-enterprise --force
--user -u Specify user email for authentication ps-enterprise -u john@example.com

Flag Inheritance

All flags are automatically passed to relevant sub-commands:

# This command will:
# 1. Use john.doe@email.com for authentication
# 2. Enable force mode for all commands that support it
ps-enterprise -u john.doe@email.com --force

Command Categories

Commands are organized into logical categories for easier navigation:

🔐 Authentication & Configuration

  • auth - Authenticate with Enterprise Platform
  • config - Configure local environment settings

📁 Environment Setup

  • clone - Clone shop files from remote
  • remote-dump - Download database dump
  • patch - Apply local configurations

🚀 Environment Management

  • start - Start local environment
  • stop - Stop local environment
  • log - Monitor environment logs
  • clean - Clean up local files

🔧 Development Tools

  • compliance - Check module compliance
  • exec - Execute commands in containers

Usage Patterns

Running Individual Commands

ps-enterprise <command> [options]

Built-in Help System

Every command includes comprehensive help documentation:

# Show all available commands
ps-enterprise --help

# Show help for a specific command
ps-enterprise auth --help
ps-enterprise config --help

Important Notes

Prerequisites

Docker Required: Ensure Docker service is running before executing any commands that interact with containers.
Authentication: Most commands require valid authentication. Run ps-enterprise auth first if you encounter authentication errors.

Command Execution Context

  • Working Directory: Commands should be run from your project directory
  • Environment Variables: Commands respect standard environment variables
  • Exit Codes: All commands return appropriate exit codes for scripting

Next Steps

  • Browse individual command documentation in the sections below
  • Get installation help from the Installation Guide
  • Learn common workflows in the Usage Guide

Select a command from the categories above to view detailed documentation, usage examples, and troubleshooting information.