Skip to content

WP-CLI commands

RowSprout Pro

RowSprout Pro 3.3.1 adds 20 wp rowsprout commands. They call the same code as the MCP abilities, and they check permissions the same way, so every command needs --user=<id>: a WordPress user who may edit the template. WP-CLI runs without a logged-in user otherwise.

Groups change only through import-groups (a CSV file, as with the import wizard) and the sync commands. There are deliberately no commands that change single properties or groups, or that repair data. Use the template editor, or the MCP abilities, for those.

Run wp help rowsprout <command> on your site for the same text as below.

Queues a template’s pages for (re)generation, or just marks them stale without generating — the same two save actions as the admin’s own “Save action” dropdown (Create & update pages / Save template only).

A group whose URL is already in use elsewhere on the site is not generated; a warning names it with a free href/slug value.

Terminal window
wp rowsprout generate <template-id> [--group-ids=<ids>] [--force] [--save-only] [--user=<id>]
Option Description
<template-id> The rowsprout_template post ID.
[--group-ids=<ids>] Comma-separated group IDs to limit this to, instead of the whole template.
[--force] Regenerate every targeted group, ignoring change detection (same as the admin’s “Regenerate all pages” checkbox). Has no effect together with –save-only.
[--save-only] Mark groups stale without queueing pages for (re)generation (same as the “Save template only” save action).
[--user=<id>] Run as this WordPress user — required for the underlying capability check to pass.

Examples

Terminal window
wp rowsprout generate 27147 --user=1
wp rowsprout generate 27147 --force --user=1
wp rowsprout generate 27147 --group-ids=389451940,220144880 --user=1

Shows generation/queue status: a site-wide summary by default, or a per-group breakdown when a template ID is given.

Terminal window
wp rowsprout queue-status [<template-id>] [--status=<status>] [--format=<format>] [--user=<id>]
Option Description
[<template-id>] Limit to this rowsprout_template post ID — shows every group’s own status instead of a site-wide summary.
[--status=<status>] Only count/show groups with this status (completed, pending, stale, failed, scheduled, in-process, waiting).
[--format=<format>] Output format: table (default), csv, json, yaml, or count.
[--user=<id>] Run as this WordPress user — only required when <template-id> is given (the site-wide summary reads the queue table directly and isn’t capability-gated).

Examples

Terminal window
wp rowsprout queue-status
wp rowsprout queue-status --status=failed
wp rowsprout queue-status 27147 --user=1

Immediately processes whatever is currently due in the generation queue, instead of waiting for the next background tick (normally within a minute, via Action Scheduler). Runs QueueProcessor::processQueue() (the exact same entry point the scheduled tick itself calls — same processing-window and license-limit rules apply) and then, when Action Scheduler dispatched work asynchronously rather than running it inline, immediately runs its own bundled wp action-scheduler run command scoped to just this plugin’s own processing hook, so this command doesn’t return before the work it just queued is done.

Terminal window
wp rowsprout process-queue

Examples

Terminal window
wp rowsprout process-queue

Lists rowsprout_template posts.

Terminal window
wp rowsprout list-templates [--status=<status>] [--search=<term>] [--page=<page>] [--per-page=<count>] [--format=<format>] [--user=<id>]
Option Description
[--status=<status>] Post status filter. Default: any.
[--search=<term>] Only templates whose title/content matches this search term.
[--page=<page>]
[--per-page=<count>] Pagination, default page 1 / 20 per page (max 100).
[--format=<format>] Output format: table (default), csv, json, yaml, or count.
[--user=<id>] Run as this WordPress user — required for the underlying capability check to pass.

Examples

Terminal window
wp rowsprout list-templates --user=1
wp rowsprout list-templates --search=Keuken --format=json --user=1

Shows a single template’s details.

Terminal window
wp rowsprout get-template <template-id> [--format=<format>] [--user=<id>]
Option Description
<template-id> The rowsprout_template post ID.
[--format=<format>] table (default, a one-row summary) or json/yaml for the full detail, including every property and group.
[--user=<id>] Run as this WordPress user — required for the underlying capability check to pass.

Examples

Terminal window
wp rowsprout get-template 27147 --user=1
wp rowsprout get-template 27147 --format=json --user=1

Lists a template’s properties (field definitions) — including any the template hasn’t explicitly saved itself yet but inherits from its parent template (see PayloadConfigBuilder::mergeInheritedFieldTypes()).

Terminal window
wp rowsprout list-properties <template-id> [--format=<format>] [--user=<id>]
Option Description
<template-id> The rowsprout_template post ID.
[--format=<format>] Output format: table (default), csv, json, yaml, or count.
[--user=<id>] Run as this WordPress user — required for the underlying capability check to pass.

Examples

Terminal window
wp rowsprout list-properties 27147 --user=1

Shows the planning of a template’s groups: for every group its state (not generated yet / planned / waiting for its parent / queued / processing / live / outdated / failed), the moment it is planned to be generated (which is when its page goes live), and when it was last generated. Read-only; works on any language’s template. Times are in the site’s timezone.

Terminal window
wp rowsprout list-planning <template-id> [--state=<state>] [--format=<format>] [--user=<id>]
Option Description
<template-id> The rowsprout_template post ID.
[--state=<state>] Only groups in this state: unplanned, planned, waiting_parent, queued, processing, live, stale, failed, deleted.
[--format=<format>] Output format: table (default), csv, json, yaml, or count.
[--user=<id>] Run as this WordPress user — required for the underlying capability check to pass.

Examples

Terminal window
wp rowsprout list-planning 27147 --user=1
wp rowsprout list-planning 27147 --state=planned --user=1

Plans — or clears — when groups are generated. Either one group (–group with –at or –clear) or many at once (–plan as JSON). All-or-nothing: if any entry is invalid nothing is saved. A child group can’t be planned earlier than its parent group. This never generates anything now — the background queue does, at the planned moment. Refused on a template that is a WPML translation of another, like every write through MCP/CLI.

Terminal window
wp rowsprout set-planning <template-id> [--group=<group-id>] [--at=<datetime>] [--clear] [--plan=<json>] [--user=<id>]
Option Description
<template-id> The rowsprout_template post ID.
[--group=<group-id>] The group to plan (use with –at or –clear).
[--at=<datetime>] When to generate it, “YYYY-MM-DD HH:MM” in the site’s timezone.
[--clear] Remove this group’s plan (use with –group).
[--plan=<json>] Plan several groups at once: a JSON object of group id => “YYYY-MM-DD HH:MM” (or “” to clear).
[--user=<id>] Run as this WordPress user — required for the underlying capability check to pass.

Examples

Terminal window
wp rowsprout set-planning 27147 --group=389451940 --at="2026-10-01 09:00" --user=1
wp rowsprout set-planning 27147 --group=389451940 --clear --user=1
wp rowsprout set-planning 27147 --plan='{"389451940":"2026-10-01 09:00","220144880":""}' --user=1

Spreads planned moments over a set of groups from a few parameters — the command-line twin of the Planning tab’s auto-fill wizard. Starting at –start it hands out –per groups per day (or hour), between –from and –to, optionally only on certain weekdays. A PREVIEW unless –save is given (–save is refused on a WPML translation; the preview works everywhere). A child group is never placed earlier than its parent group.

Terminal window
wp rowsprout autofill-planning <template-id> --start=<datetime> [--per=<n>] [--period=<period>] [--from=<time>] [--to=<time>] [--weekdays=<list>] [--order=<order>] [--apply=<which>] [--group-ids=<ids>] [--save] [--format=<format>] [--user=<id>]
Option Description
<template-id> The rowsprout_template post ID.
--start=<datetime> First possible moment, “YYYY-MM-DD HH:MM” in the site’s timezone.
[--per=<n>] Groups per period. Default 5.
[--period=<period>] day (default) or hour.
[--from=<time>] Daily window start, HH:MM. Default 09:00.
[--to=<time>] Daily window end, HH:MM. Default 17:00.
[--weekdays=<list>] Only on these weekdays: comma-separated numbers (0 = Sunday … 6 = Saturday) or names (mon,tue,…). Default: every day.
[--order=<order>] table (default), title (alphabetical) or random.
[--apply=<which>] Which groups: empty (default — groups without a plan) or all.
[--group-ids=<ids>] Comma-separated group IDs to plan instead (overrides –apply).
[--save] Store the result. Without it this only shows the proposal.
[--format=<format>] Output format for the proposal: table (default), csv, json, yaml.
[--user=<id>] Run as this WordPress user — required for the underlying capability check to pass.

Examples

Terminal window
wp rowsprout autofill-planning 27147 --start="2026-10-01 09:00" --per=5 --user=1
wp rowsprout autofill-planning 27147 --start="2026-10-01 09:00" --per=3 --weekdays=mon,wed,fri --order=random --save --user=1

Exports templates as a RowSprout export file (the same JSON as RowSprout → Import / Export). A child template always comes with its parent (a parent comes without its children: name those too) and, with WPML, a template with its translations.

Terminal window
wp rowsprout export-templates <template-id>... [--file=<path>] [--user=<id>]
Option Description
<template-id>... One or more rowsprout_template post IDs.
[--file=<path>] Write the file here instead of printing it.
[--user=<id>] Run as this WordPress user — needs the “export” capability.

Examples

Terminal window
wp rowsprout export-templates 22529 --file=templates.json --user=1

Imports a RowSprout export file. Every template in it is added as a new draft; existing templates are never changed and nothing is generated. (Updating existing templates from a file is only offered in the admin.)

Terminal window
wp rowsprout import-templates <file> [--download-media] [--user=<id>]
Option Description
<file> The export file (JSON).
[--download-media] Download featured images and Thumbnail images that are not in this site’s media library from the source site.
[--user=<id>] Run as this WordPress user — needs the “import” capability.

Examples

Terminal window
wp rowsprout import-templates templates.json --user=1

Exports a template’s groups as CSV (as “Download groups” in the editor).

Terminal window
wp rowsprout export-groups <template-id> [--format=<format>] [--file=<path>]
Option Description
<template-id> The template.
[--format=<format>] csv-utf8 (default), csv-utf8-semicolon, tab or csv-plain.
[--file=<path>] Write the file here (with the byte order mark spreadsheet apps need) instead of printing it.

Examples

Terminal window
wp rowsprout export-groups 22529 --file=groups.csv --user=1

Imports groups from a CSV file or URL, as the editor’s “Import groups” wizard does: rows with an existing group’s ID or URL update it, other rows become new groups; columns are matched as the wizard suggests.

Terminal window
wp rowsprout import-groups <template-id> <file-or-url> [--sheet=<name>] [--header=<header>] [--map=<choices>] [--delimiter=<char>] [--dry-run] [--delete-missing]
Option Description
<template-id> The template.
<file-or-url> A local CSV, Excel (.xlsx) or JSON file, or a URL (also a JSON feed, or a Google Sheets link shared with “Anyone with the link”).
[--sheet=<name>] Excel: the worksheet. JSON: the list of items as a dot path, e.g. data.items ($ = the root list). Default: the first worksheet, or the largest list.
[--header=<header>] A header the URL needs, as “Name: value”, or a bearer token. Default: the one the template’s sync keeps for the URL.
[--map=<choices>] Per column (header or number from 1): skip, id, a property (key, code or label), or new:<type>[:<label>]. As JSON, or as “Header=choice,Other=choice”.
[--delimiter=<char>] Overrides the detected delimiter (one character, or “tab”).
[--dry-run] Only show what would change.
[--delete-missing] Delete the groups that are not in the file, with their pages.

Examples

Terminal window
wp rowsprout import-groups 22529 groups.csv --dry-run --user=1
wp rowsprout import-groups 22529 "https://docs.google.com/spreadsheets/d/…/edit#gid=0" --map="Region=new:textfield" --user=1

Lists the templates whose groups are synced with a CSV URL.

Terminal window
wp rowsprout list-syncs [--format=<format>]
Option Description
[--format=<format>] table (default), csv, json or yaml.

Shows the log of sync runs, newest first.

Terminal window
wp rowsprout sync-log [--template=<id>] [--status=<status>] [--limit=<n>] [--format=<format>]
Option Description
[--template=<id>] Only this template.
[--status=<status>] ok, unchanged, warning, failed or paused.
[--limit=<n>] At most this many runs (default 50, at most 200).
[--format=<format>] table (default), csv, json or yaml.

Runs a template’s sync now.

Terminal window
wp rowsprout run-sync <template-id>
Option Description
<template-id> The template.

Sets up or changes a template’s sync with a CSV URL. The URL is read now to choose the columns (as the wizard suggests; –map overrides); nothing is imported until the sync runs.

Terminal window
wp rowsprout set-sync <template-id> --source=<url> [--sheet=<name>] [--header=<header>] [--interval=<interval>] [--time=<time>] [--time2=<time>] [--weekday=<day>] [--delete-missing=<yes-or-no>] [--map=<choices>] [--delimiter=<char>] [--run-now]
Option Description
<template-id> The template.
--source=<url> A CSV, Excel or JSON file on the web, a REST API returning JSON, or a Google Sheets link shared with “Anyone with the link”.
[--sheet=<name>] Excel: the worksheet. JSON: the list of items as a dot path ($ = the root list). Default: the current one, else the first worksheet or the largest list.
[--header=<header>] A header every run sends, as “Name: value” or a bearer token; kept with the sync. Default: the saved one for the same URL; “none” removes it.
[--interval=<interval>] hourly, twicedaily, daily or weekly (a new sync: daily).
[--time=<time>] In the site’s time zone (a new sync: 03:00). Hourly: the minute of every hour.
[--time2=<time>] twicedaily: the second time.
[--weekday=<day>] weekly: 1 (Monday) to 7 (Sunday).
[--delete-missing=<yes-or-no>] Delete groups whose row disappears (never on a child template).
[--map=<choices>] Per column: skip, id or a property; as JSON or “Header=choice,Other=choice”.
[--delimiter=<char>] Overrides the detected delimiter.
[--run-now] Run the sync right away too.

Examples

Terminal window
wp rowsprout set-sync 22529 --source="https://docs.google.com/spreadsheets/d/…/edit#gid=0" --interval=daily --time=04:00 --run-now --user=1

Pauses a template’s sync.

Terminal window
wp rowsprout pause-sync <template-id>
Option Description
<template-id> The template.

Resumes a paused sync.

Terminal window
wp rowsprout resume-sync <template-id>
Option Description
<template-id> The template.

Stops a template’s sync (the groups stay as they are).

Terminal window
wp rowsprout stop-sync <template-id>
Option Description
<template-id> The template.