CLI

Blockstudio registers WP-CLI commands for managing blocks, file-backed pages, database records, RPC functions, cron jobs, and settings from the terminal.

Blocks

List all blocks

wp bs blocks list

+----------------------------+---------------------+-----------+------------------------+
| name                       | title               | component | category               |
+----------------------------+---------------------+-----------+------------------------+
| my-theme/hero              | Hero                |           | my-theme               |
| my-theme/card              | Card                | yes       | my-theme               |
| my-theme/newsletter        | Newsletter          |           | my-theme               |
+----------------------------+---------------------+-----------+------------------------+

Filter to components only

wp bs blocks list --components

Output as JSON

wp bs blocks list --format=json

Pages

File-backed page synchronization is explicit. Ordinary WordPress requests never perform complete page discovery or write page posts. A cold runtime may read collection manifests once to restore routes, without synchronizing content.

wp bs pages sync

The command reconciles the complete desired inventory and reports discovered, created, updated, unchanged, removed, and failed pages. Equal fingerprints produce no post or post-meta writes.

Use --authoritative to replace managed content instead of preserving keyed editor content, and --full to force a full comparison:

wp bs pages sync --authoritative --full

For deployment scripts that need the complete report:

wp bs pages sync --format=json

The command exits unsuccessfully when discovery or reconciliation reports an error. See Pages for the PHP API and deployment identity contract.

Database

List schemas

wp bs db schemas

+-------------------+-------------+---------+---------------------+
| block             | schema      | storage | fields              |
+-------------------+-------------+---------+---------------------+
| my-theme/app      | subscribers | table   | email, name, plan   |
| my-theme/app      | logs        | jsonc   | action, details     |
| my-theme/app      | events      | storh   | title, status       |
+-------------------+-------------+---------+---------------------+

CRUD operations

# List records
wp bs db list my-theme/app subscribers

# List with filters
wp bs db list my-theme/app subscribers --plan=pro --limit=10

# Get a single record
wp bs db get my-theme/app subscribers 1

# Create a record
wp bs db create my-theme/app subscribers --email=a@b.com --plan=pro

# Update a record
wp bs db update my-theme/app subscribers 1 --plan=enterprise

# Delete a record
wp bs db delete my-theme/app subscribers 1

For single-schema blocks, the schema name defaults to default:

wp bs db list my-theme/leads

Migrate JSONC records to Storh

Use migrate when a schema already has a db/{schema}.jsonc file and you want to move those records into the Storh file backend:

wp bs db migrate my-theme/app subscribers --to=storh

For single-schema blocks:

wp bs db migrate my-theme/app --to=storh

The command preserves integer record IDs, writes to uploads/blockstudio/db/{block-scope}/{schema}/, rebuilds Storh indexes, verifies the target store, and leaves the source .jsonc file in place.

Output formats

All list commands support --format=table (default), --format=json, and --format=csv:

wp bs db list my-theme/app subscribers --format=json

RPC

List all functions

wp bs rpc list

+-------------------+-------------+--------+----------------+---------+
| block             | function    | public | capability     | methods |
+-------------------+-------------+--------+----------------+---------+
| my-theme/app      | subscribe   | yes    |                | POST    |
| my-theme/app      | stats       |        | edit_posts     | POST    |
| my-theme/app      | get_status  |        |                | GET,POST|
+-------------------+-------------+--------+----------------+---------+

Call a function

wp bs rpc call my-theme/app subscribe --email=user@example.com

Output is JSON:

{
  "success": true
}

Parameters are passed as --key=value flags:

wp bs rpc call my-theme/app load_more --offset=10 --limit=5

Cron

List all jobs

wp bs cron list

+-------------------+----------+----------+---------------------+
| block             | job      | schedule | next_run            |
+-------------------+----------+----------+---------------------+
| my-theme/app      | cleanup  | daily    | 2026-03-17 00:00:00 |
| my-theme/app      | sync     | hourly   | 2026-03-16 15:00:00 |
+-------------------+----------+----------+---------------------+

Run a job manually

wp bs cron run my-theme/app cleanup

This executes the callback immediately, regardless of the schedule. Useful for testing and debugging.

Settings

Show all settings

wp bs settings list

Get a specific setting

wp bs settings get tailwind/enabled
wp bs settings get assets/enqueue

Tailwind

Compile HTML to CSS

wp bs tailwind compile '<div class="flex items-center p-4">'

Compile from file

wp bs tailwind compile --file=template.html

Cache management

wp bs tailwind cache path    # show cache directory
wp bs tailwind cache clear   # clear compiled cache

SCSS

Compile SCSS to CSS

wp bs scss compile '$color: red; .test { color: $color; }'

Compile from file

wp bs scss compile --file=styles.scss

Custom Fields

List all registered custom fields

wp bs fields list

+-------+----------------+---------------------------+
| name  | title          | fields                    |
+-------+----------------+---------------------------+
| hero  | Hero Section   | heading, description, cta |
| card  | Card           | title, image, link        |
+-------+----------------+---------------------------+

Assets

List all assets

wp bs assets list

Filter by type

wp bs assets list --type=global
wp bs assets list --type=admin
wp bs assets list --type=editor
wp bs assets list --type=registered

Scripting

All commands support --format=json for easy piping:

# Export all subscribers as JSON
wp bs db list my-theme/app subscribers --format=json > subscribers.json

# Count records
wp bs db list my-theme/app subscribers --format=json | jq length

# Batch delete
wp bs db list my-theme/app logs --format=json | \
  jq -r '.[].id' | \
  xargs -I {} wp bs db delete my-theme/app logs {}

Content Sync

Content Sync projects allowlisted WordPress content to files and applies those files back to the database. It is explicit and CLI-driven; it does not sync on page load or admin initialization.

See Content Sync for configuration, file format, and guidance on when file-based database content is a good fit.

Pull database content to files

wp bs content pull

Limit the pull to one configured post type or taxonomy:

wp bs content pull --post-type=team_member
wp bs content pull --taxonomy=category

Preview without writing UIDs or files:

wp bs content pull --dry-run

Push files to the database

wp bs content push

Preview the apply plan without writing:

wp bs content push --dry-run

Prune content-set owned database posts and terms that no longer exist in files:

wp bs content push --prune --yes

With --prune, Blockstudio applies all file changes first, then removes content-set owned entities that no longer exist in the files. It refuses to run a destructive prune unless --yes is present.

Check status

wp bs content status

The table reports each file-backed entity as unchanged, would-update, missing-db, conflict, locked, or orphaned.

Static Prerendering

See Static Prerendering for the cache itself; these commands drive it.

Warm stale entries

wp bs prerender warm

Processes the durable warm queue: stale or invalidated URLs are re-rendered and republished. Content and site changes enqueue replacement jobs automatically; this command works the queue down.

Report cache state

wp bs prerender status

Reports the active identity, files, bytes, graph records, queue state, and per-scope hit/miss/build/failure counters.

Purge the cache

wp bs prerender purge

Removes the current site’s prerendered documents. The next anonymous request or warm pass rebuilds them.

Block Tag Migration

A standalone script rewrites prefix and alias shorthands to the canonical <bs:namespace-slug> spelling. It does not load WordPress and does not write unless --apply is explicitly supplied:

php vendor/blockstudio/blockstudio/bin/migrate-block-tags.php \
  --root="$PWD" \
  --prefix-map=/tmp/project-prefixes.json \
  --known-blocks=/tmp/project-blocks.json \
  --aliases=/tmp/project-aliases.json \
  --report=/tmp/blockstudio-tag-migration.json \
  --dry-run

The prefix file maps caller-owned prefixes to ordered namespaces. The known block file is a JSON list of registered block names. Exact aliases are optional. The report includes deterministic mappings, before/after hashes, unknown tags, ambiguous aliases, dynamic tags, and examples found in comments, code fences, <pre>, or <code> ranges.

The scanner handles paired, nested, and self-closing markup, including literal tags in PHP strings. It preserves attributes and changes only tag names. Comments and code samples are report-only. Unrelated custom elements are ignored. Applying a migration is blocked while unknown, ambiguous, or dynamic cases remain unless the caller deliberately passes --allow-unresolved. Running the command again over canonical output produces no changes.

See Migration for why the canonical spelling exists and what it resolves.

Teardown

wp bs teardown

Removes the cron events and static prerender state an installation owns: the current site’s early-serve map entry, and the shared advanced-cache.php drop-in and WP_CACHE declaration once the final owned entry is gone. Installations without a plugin deactivation hook, such as Composer-bundled setups, use this for a clean removal. Configuration files are left untouched.