Skip to content
LoopressLoopressLoopressAlpha
Blog

Getting Started

Loopress has two parts: a WordPress plugin and a CLI.

The plugin works standalone, straight from the WordPress admin, for Composer dependency management. The CLI requires the plugin to be installed and active on the site you want to manage, lps project config installs it for you automatically if it’s missing, no manual upload needed.

Here’s the whole setup, from installing the CLI to syncing the first snippets:

Prerequisites

Section titled “Prerequisites”
  • A WordPress installation (6.0+) with administrator access
  • PHP 8.2+ on the server
  • Node.js 18+ on your machine, for the CLI
  • A local Chrome, Edge, or Chromium install, only needed for the automatic plugin install below

Quick start (under a minute)

Section titled “Quick start (under a minute)”

1. Install the CLI

Section titled “1. Install the CLI”
Terminal window
npm install -g @loopress/cli

2. Connect it to your site

Section titled “2. Connect it to your site”
Terminal window
lps project config

Enter your WordPress URL, then choose Authorize in my browser (recommended). This opens your WordPress admin and creates an Application Password for you automatically. If it can’t complete (or you’d rather enter credentials yourself), fall back to manual entry, see the Application Passwords guide if you can’t find that section in your WordPress admin.

If Loopress Full isn’t active on the site yet, project config offers to install it for you: it downloads the latest release, creates a temporary administrator account, uploads and activates the plugin through a headless browser, then deletes the temporary account, all with a confirmation prompt before anything is created. If the automatic install can’t complete (some managed hosts block file uploads via DISALLOW_FILE_MODS), the command falls back to instructions for a manual upload, see the plugin page either way.

3. Sync your first snippets

Section titled “3. Sync your first snippets”
Terminal window
# Download your existing snippets as .php files
lps snippet pull


# Edit locally, commit to Git
git add snippets/ && git commit -m "chore: import snippets"


# Push changes back to WordPress
lps snippet push

This works with either WPCode or the Code Snippets plugin, whichever is active on the site.

Need Composer or plugin version management too? Continue with the CLI reference or the WordPress plugin docs.

Want to see it all wired together, including CI and E2E tests? github.com/loopress/demo is a small reference project you can clone.