WordPress.org
Get WordPress

Plugin Directory

Changeset 3475957


Ignore:
Timestamp:
03/05/2026 09:44:02 PM (2 days ago)
Author:
shift8
Message:

Updated readme with wp-cli documentation

File:
1 edited

Legend:

Unmodified
Added
Removed

  • shift8-real-estate-listings-for-treb/trunk/readme.txt

    r3475951 r3475957  
    113113= Can I import specific listings? =
    114114
    115 Yes, use the WP-CLI command: `wp shift8-treb import W12345678,C12345679` to import specific MLS numbers.
     115Yes, use the WP-CLI command: `wp shift8-treb sync --mls=W12345678,C12345679` to import specific MLS numbers.
    116116
    117117= How do I troubleshoot sync issues? =
    … …  
    1201202. Run a manual sync to generate logs
    1211213. Check the log viewer for error messages
    122 4. Use the API connection tester
     1224. Use the API connection tester: `wp shift8-treb test_api`
    1231235. Use `wp shift8-treb analyze` for raw API diagnostics
     1246. Use `wp shift8-treb preview` to verify filters without creating posts
    124125
    125126= Does this work with multisite? =
    126127
    127128The plugin is designed for single-site installations. Multisite compatibility is not currently supported.
     129
     130= What WP-CLI commands are available? =
     131
     132The plugin provides a full suite of WP-CLI commands under the `wp shift8-treb` namespace. See the WP-CLI Reference section below for complete documentation of each command with all options and parameters.
    128133
    129134== Screenshots ==
    … …  
    1331383. Log viewer showing detailed sync progress and debugging information
    1341394. Quick stats widget displaying sync status and listing counts
     140
     141== WP-CLI Reference ==
     142
     143All commands are registered under `wp shift8-treb`. WP-CLI must be installed on the server.
     144
     145= wp shift8-treb sync =
     146
     147Run a manual sync of TREB listings from the PropTx RESO Web API.
     148
     149Options:
     150
     151* `--dry-run` - Run without creating or updating any posts.
     152* `--verbose` - Show detailed output including settings, sample data, and progress.
     153* `--limit=<number>` - Limit the number of listings to process. Overrides admin settings.
     154* `--force` - Force sync even if the bearer token is not configured.
     155* `--listing-age=<days>` - Override listing age in days. Ignores incremental sync and uses age-based filtering.
     156* `--mls=<numbers>` - Import specific MLS number(s), comma-separated. Example: `W12436591,C12380184`
     157* `--members-only` - Sync only listings from configured member IDs. Applies filter at API level.
     158* `--postal-prefix=<prefixes>` - Override geographic filter with postal code prefixes (FSA). Comma-separated. Example: `M5V,M6H`. Mutually exclusive with `--city`.
     159* `--city=<cities>` - Override geographic filter with city names. Comma-separated. Example: `"Toronto W08,Mississauga"`. Mutually exclusive with `--postal-prefix`.
     160* `--skip-images` - Skip image downloads for faster sync. Stores external URLs only.
     161* `--sequential-images` - Use sequential image processing instead of batch. Slower but more compatible.
     162
     163Examples:
     164
     165    wp shift8-treb sync
     166    wp shift8-treb sync --dry-run --verbose
     167    wp shift8-treb sync --listing-age=7 --limit=50
     168    wp shift8-treb sync --mls=W12436591,C12380184
     169    wp shift8-treb sync --members-only --skip-images
     170    wp shift8-treb sync --postal-prefix=M5V,M6H
     171    wp shift8-treb sync --city="Brampton,Oakville" --limit=20
     172
     173= wp shift8-treb preview =
     174
     175Query the API and display a summary of matching listings without creating any posts. Output includes price range and median, city breakdown, property type breakdown, and top agents.
     176
     177Options:
     178
     179* `--limit=<number>` - Limit number of listings to fetch.
     180* `--listing-age=<days>` - Override listing age in days.
     181* `--members-only` - Only show listings from configured member IDs.
     182* `--postal-prefix=<prefixes>` - Override geographic filter with postal code prefixes. Mutually exclusive with `--city`.
     183* `--city=<cities>` - Override geographic filter with city names. Mutually exclusive with `--postal-prefix`.
     184* `--format=<format>` - Output format: `table` (default) or `json`.
     185
     186Examples:
     187
     188    wp shift8-treb preview
     189    wp shift8-treb preview --postal-prefix=M5V,M6H,M8X
     190    wp shift8-treb preview --city="Toronto W08,Mississauga"
     191    wp shift8-treb preview --limit=20 --members-only
     192    wp shift8-treb preview --format=json
     193
     194= wp shift8-treb analyze =
     195
     196Fetch raw API data for diagnostic analysis. Supports searching for specific MLS numbers and showing agent breakdowns. No posts are created.
     197
     198Options:
     199
     200* `--limit=<number>` - Maximum listings to analyze. Default: 50.
     201* `--search=<mls>` - Search for specific MLS number(s). Comma-separated.
     202* `--show-agents` - Show unique agent IDs and their listing counts.
     203* `--days=<number>` - Number of days to look back. Default: 90.
     204* `--members-only` - Only analyze listings from configured member IDs.
     205* `--postal-prefix=<prefixes>` - Override geographic filter. Mutually exclusive with `--city`.
     206* `--city=<cities>` - Override geographic filter. Mutually exclusive with `--postal-prefix`.
     207
     208Examples:
     209
     210    wp shift8-treb analyze --limit=100 --show-agents
     211    wp shift8-treb analyze --search=W12436591,C12380184
     212    wp shift8-treb analyze --days=30 --limit=200
     213    wp shift8-treb analyze --city="Mississauga" --days=30
     214
     215= wp shift8-treb settings =
     216
     217Display current plugin configuration. Sensitive values such as the bearer token are masked.
     218
     219Options:
     220
     221* `--format=<format>` - Output format: `table` (default), `json`, or `yaml`.
     222
     223Examples:
     224
     225    wp shift8-treb settings
     226    wp shift8-treb settings --format=json
     227
     228= wp shift8-treb test_api =
     229
     230Test the PropTx RESO Web API connection using the configured bearer token.
     231
     232No options. Example:
     233
     234    wp shift8-treb test_api
     235
     236= wp shift8-treb test_media <listing_key> =
     237
     238Test the Media API for a specific listing. Shows available photos with URLs, types, order, and preferred photo status.
     239
     240Arguments:
     241
     242* `<listing_key>` - The MLS listing key. Example: `W12438713`
     243
     244Options:
     245
     246* `--raw` - Show the full raw JSON API response.
     247
     248Examples:
     249
     250    wp shift8-treb test_media W12438713
     251    wp shift8-treb test_media W12438713 --raw
     252
     253= wp shift8-treb sync_status =
     254
     255Show current sync mode (incremental or age-based), last sync timestamp, and relevant settings.
     256
     257No options. Example:
     258
     259    wp shift8-treb sync_status
     260
     261= wp shift8-treb reset_sync =
     262
     263Reset the incremental sync timestamp. Forces next sync to use age-based filtering, re-importing listings that may have been deleted locally.
     264
     265Options:
     266
     267* `--yes` - Skip the confirmation prompt.
     268
     269Examples:
     270
     271    wp shift8-treb reset_sync
     272    wp shift8-treb reset_sync --yes
     273
     274= wp shift8-treb clear_logs =
     275
     276Clear all plugin sync logs.
     277
     278Options:
     279
     280* `--yes` - Skip the confirmation prompt.
     281
     282Examples:
     283
     284    wp shift8-treb clear_logs
     285    wp shift8-treb clear_logs --yes
     286
     287= wp shift8-treb retry-images =
     288
     289Retry downloading failed images for posts that have stored external image references. Draft posts are auto-published if the retry succeeds.
     290
     291Options:
     292
     293* `--limit=<number>` - Limit number of posts to process. Default: unlimited.
     294* `--dry-run` - Show what would be processed without downloading.
     295* `--status=<status>` - Only process posts with a specific status: `draft`, `publish`, or `any` (default).
     296
     297Examples:
     298
     299    wp shift8-treb retry-images
     300    wp shift8-treb retry-images --dry-run
     301    wp shift8-treb retry-images --status=draft
     302    wp shift8-treb retry-images --limit=10
    135303
    136304== Changelog ==
Note: See TracChangeset for help on using the changeset viewer.