Skip to main content

Running Commands

This guide covers the commands available via SSH on your staging environment.

Interactive Mode​

Connect without a command to enter an interactive shell:

ssh [email protected]

You'll get a wp-shell> prompt where you can run multiple commands without reconnecting:

WordPress Restricted Shell
Type 'help' for available commands, 'exit' to quit.

wp-shell> wp plugin list
wp-shell> composer show
wp-shell> exit

Single Command Mode​

Run a single command and exit:

ssh {slug}[email protected] 'command here'

Replace {slug} with your site's slug.

File Operations​

Listing Files​

# List files in WordPress root
ssh [email protected] 'ls -la'

# List plugins
ssh [email protected] 'ls -la wp-content/plugins/'

# List themes
ssh [email protected] 'ls -la wp-content/themes/'

Viewing Files​

# View a file
ssh [email protected] 'cat wp-config.php'

# View with line numbers
ssh [email protected] 'cat -n wp-content/themes/mytheme/functions.php'

WP-CLI​

WP-CLI is the command-line interface for WordPress.

Plugin Management​

# List all plugins
ssh [email protected] 'wp plugin list'

# Install a plugin
ssh [email protected] 'wp plugin install woocommerce'

# Activate a plugin
ssh [email protected] 'wp plugin activate woocommerce'

# Update all plugins
ssh [email protected] 'wp plugin update --all'

# Deactivate and delete a plugin
ssh [email protected] 'wp plugin deactivate hello && wp plugin delete hello'

Theme Management​

# List themes
ssh [email protected] 'wp theme list'

# Activate a theme
ssh [email protected] 'wp theme activate flavor'

Database Operations​

# Export database to local file
ssh [email protected] 'wp db export -' > backup.sql

# Search and replace (useful for domain changes)
ssh [email protected] 'wp search-replace "old-domain.com" "new-domain.com" --dry-run'

# Run the replacement (remove --dry-run)
ssh [email protected] 'wp search-replace "old-domain.com" "new-domain.com"'

User Management​

# List users
ssh [email protected] 'wp user list'

# Create a user
ssh [email protected] 'wp user create bob [email protected] --role=editor'

# Reset a password
ssh [email protected] 'wp user update admin --user_pass=newpassword'

Cache Management​

# Flush object cache
ssh [email protected] 'wp cache flush'

# Flush rewrite rules
ssh [email protected] 'wp rewrite flush'

WooCommerce Commands​

# List orders
ssh [email protected] 'wp wc shop_order list --user=1'

# Update stock
ssh [email protected] 'wp wc product update 123 --stock_quantity=50 --user=1'
WP-CLI Documentation

For the full list of WP-CLI commands, see the WP-CLI Command Reference.

Composer​

Manage PHP dependencies with Composer.

# Install dependencies
ssh [email protected] 'composer install'

# Update dependencies
ssh [email protected] 'composer update'

# Require a new package
ssh [email protected] 'composer require vendor/package'

# Show installed packages
ssh [email protected] 'composer show'
Composer on Production

Composer changes on staging need to be deployed to production via the normal deployment process. Running composer install on staging doesn't affect production.