GatherPress registers its commands under a single gatherpress namespace, in Core\Cli. They only exist when WP-CLI is loaded, so nothing is added to a normal page request.

Two command groups ship with the plugin today:

Every command supports WP-CLI's own global flags, so --url picks a site on multisite and --user changes who the command runs as.

Run wp help gatherpress event rsvp for the same reference from your terminal. WP-CLI builds it from the command's docblock.

Records an RSVP, or changes one that already exists. This is the same path the front-end RSVP block takes, so the same rules apply: the waiting list fills when the event is at capacity, and promotions happen automatically when somebody drops out.

wp gatherpress event rsvp --event_id=<id> --user_id=<id> [--status=<status>] [--guests=<n>] [--anonymous=<0|1>]

# RSVP as attending.
wp gatherpress event rsvp --event_id=525 --user_id=1

# Cancel.
wp gatherpress event rsvp --event_id=525 --user_id=1 --status=not_attending

# Bring two guests, without appearing in the public list.
wp gatherpress event rsvp --event_id=525 --user_id=1 --guests=2 --anonymous=1

The command targets any post type that declares the gatherpress-rsvp support, not just gatherpress_event. See post type supports. A post that does not support RSVPs is refused:

Error: Event ID "525" does not exist or does not support RSVPs.

Writes every GatherPress setting to JSON. With no --file it goes to stdout, so it pipes.

# Look at the current settings.
wp gatherpress settings export

# Save them.
wp gatherpress settings export --file=gatherpress-settings.json

The export deliberately leaves out settings marked non-exportable, which is how credentials and site-specific values stay out of a file that gets copied between installs. Extending settings covers the exportable flag, and the settings architecture covers the format.

On multisite the export carries a scope field recording whether it came from a single site or from network admin, so an import knows where it belongs. See multisite settings.

Reads a file produced by export. It does not change anything unless you pass --apply. Without that flag it prints what would change and stops.

# Preview. Changes nothing.
wp gatherpress settings import gatherpress-settings.json

# Apply, keeping settings the file does not mention.
wp gatherpress settings import gatherpress-settings.json --apply

# Apply, discarding settings the file does not mention.
wp gatherpress settings import gatherpress-settings.json --apply --mode=replace

Settings marked non-exportable are also not importable, so a hand-edited file cannot be used to push them in.

GatherPress Alpha adds its own command for repairing data after an upgrade:

wp gatherpress alpha fix

It is documented with the plugin itself, not here. See getting started.

Commands are registered in one place, in Core\Cli's constructor:

WP_CLI::add_command( 'gatherpress event', Event_Cli::class );
WP_CLI::add_command( 'gatherpress settings', Settings_Cli::class );

A command class lives in includes/core/classes/commands/, extends WP_CLI, and turns each public method into a subcommand. The docblock is not decoration: WP-CLI parses ## OPTIONS into the command's synopsis and rejects any argument that is not declared there, so an option you read in the method body but forget in the docblock will never reach it.

/**
 * One-line description, which becomes the command's summary.
 *
 * ## OPTIONS
 *
 * [--guests=<guests>]
 * : Number of guests accompanying the attendee.
 * ---
 * default: 0
 * ---
 *
 * ## EXAMPLES
 *
 *    # What somebody would actually type.
 *    $ wp gatherpress event rsvp --event_id=525 --user_id=1
 *
 * @since TBD
 *
 * @param string[]                   $args       Positional arguments.
 * @param array<string, string|bool> $assoc_args Associative arguments.
 *
 * @return void
 */
public function rsvp( array $args = array(), array $assoc_args = array() ): void {

Two things worth copying from the existing commands:

• A bare --flag with no value arrives as true, not a string. Settings_Cli::export() checks is_string() before treating --file as a path, because wp gatherpress settings export --file would otherwise try to write to 1.
• Destructive commands default to a dry run. settings import requires --apply before it writes anything, which makes the safe invocation the short one.