CLI - Getting Started

The Loopress CLI (lps) is a Node.js command-line tool for version-controlling WordPress data and syncing it between your local machine and any WordPress instance.

Installation

npm install -g @loopress/cli

Or with pnpm:

pnpm add -g @loopress/cli

Verify the installation:

lps --version

Requirements

• Node.js 18+
• A WordPress installation with the Code Snippets plugin active (for snippet commands)
• A WordPress Application Password for authentication

Configure a site

Before running any command, register your WordPress site:

lps site config

You will be prompted for:

Prompt	Description
Site name	A local identifier (e.g. production, staging)
WordPress URL	Full URL including scheme (https://example.com)
Username	Your WordPress administrator username
Application password	Generated in Users → Profile → Application Passwords

Manage multiple sites

Loopress stores site configurations in ~/.config/loopress/sites.json and keeps track of the currently active site.

lps site config          # Add or update a site
lps site switch          # Interactively pick the active site
lps site remove <name>   # Remove a saved site

All commands operate against the active site unless overridden via environment variables.

Environment variable fallback

For CI/CD pipelines where interactive prompts are not available, you can bypass the site configuration entirely using environment variables:

export WP_URL=https://example.com
export WP_USERNAME=admin
export WP_APP_PASSWORD="xxxx xxxx xxxx xxxx xxxx xxxx"

lps snippets push

Dry run

Most commands accept a --dryRun (-d) flag that shows what would happen without making any changes:

lps snippets push --dryRun
lps snippets pull --dryRun
lps acf pull --dryRun