CLI referencia

Megtekintés Markdownként Szerkesztés itt: GitHub Dokumentáció itt: 2cc7b2b

Alapértelmezés szerint minden Queuety művelet elérhető a WP-CLI felületen, a wp queuety névtérben.

Ha ugyanazt a parancsfát más gyökér alatt szeretné közzétenni, például wp themequeue alatt, határozza meg a QUEUETY_CLI_COMMAND értékét a Queuety elindulása előtt.

Az ügynökök tesztkörnyezeteihez és más virtuális bash-integrációkhoz ezt az oldalt tekintse emberi referenciának, a PHP hidat pedig gépi szerződésnek:

A Queuety::cli_command_map() szerializálható parancskatalógust tesz elérhetővé
A Queuety::resolve_cli_command( $path, $args, $assoc_args ) az elemzett wp queuety ... bemenetet normalizált végrehajtási tervvé alakítja, amely előnyben részesíti a közvetlen PHP hívható elemeket

Ebben a fában az állapotgépekhez nincsenek parancsok; a Állapotgépek című részben leírt PHP API segítségével vizsgálhatja meg őket.

Feladatparancsok

`wp queuety work`

Elindít egy munkavégzőt, amely feladatokat dolgoz fel.

Shell

wp queuety work [--queue=<queue>] [--once] [--workers=<n>]
wp queuety work [--queue=<queue>] [--min-workers=<n>] --max-workers=<n>

Beállítás	Leírás
`--queue=<queue>`	Feldolgozandó Queue(s); prioritási sorrendhez vesszővel elválasztva (alapértelmezett: `default`)
`--once`	Legfeljebb egy feladatot dolgoz fel, majd kilép (akkor is azonnal kilép, ha nincs igényelhető feladat)
`--workers=<n>`	N munkavégző-folyamatot indít külön folyamatként (ehhez szükséges a `pcntl` és a `posix` bővítmény; ugyanez érvényes a `--min-workers` és a `--max-workers` esetén is)
`--min-workers=<n>`	Minimális munkavégzőszám dinamikusan alkalmazkodó készlethez. Szükséges hozzá a `--max-workers`
`--max-workers=<n>`	Maximális munkavégzőszám dinamikusan alkalmazkodó készlethez

Shell

# Single worker on default queue
wp queuety work

# Process a specific queue
wp queuety work --queue=emails

# Process multiple queues in priority order
wp queuety work --queue=critical,default,low

# One-shot mode
wp queuety work --once

# Multi-worker mode
wp queuety work --workers=4

# Adaptive worker pool
wp queuety work --queue=providers --min-workers=2 --max-workers=6

Ha több várólistát ad meg, a munkavégző a felsorolt sorrendben próbál feladatot igényelni mindegyikből. Az első várólista nyer, amelyben van elérhető feladat. A --workers rögzített méretű készletet tart fenn. A --min-workers és a --max-workers lehetővé teszi a dinamikus méretezést ugyanazon a parancsfelületen. Az üzembe helyezési stratégiákért lásd a Munkavégzők, a dinamikusan alkalmazkodó készletek felvételi modelljéért pedig az Erőforrás-kezelés című részt.

`wp queuety flush`

Az összes függőben lévő feladat feldolgozása, majd kilépés.

Shell

wp queuety flush [--queue=<queue>]

Beállítás	Leírás
`--queue=<queue>`	Kiürítendő Queue(s); prioritási sorrendhez vesszővel elválasztva (alapértelmezett: `default`)

Shell

# Flush a single queue
wp queuety flush --queue=emails

# Flush multiple queues in priority order
wp queuety flush --queue=critical,default,low

`wp queuety dispatch`

Feladat elküldése a parancssorból.

Shell

wp queuety dispatch <handler> [--payload=<json>] [--queue=<queue>] [--priority=<priority>] [--delay=<seconds>]

Beállítás	Leírás
`<handler>`	Kezelő neve vagy osztálya (kötelező)
`--payload=<json>`	JSON hasznos adat (alapértelmezett: `{}`)
`--queue=<queue>`	Várólista neve (alapértelmezett: `default`)
`--priority=<priority>`	Prioritási szint, 0–3 (alapértelmezett: `0`)
`--delay=<seconds>`	Késleltetés másodpercben (alapértelmezett: `0`)

Shell

wp queuety dispatch send_email --payload='{"to":"user@example.com"}' --queue=emails

`wp queuety status`

Várólista-statisztikák megjelenítése.

Shell

wp queuety status [--queue=<queue>]

Beállítás	Leírás
`--queue=<queue>`	Szűrés várólistanév szerint

`wp queuety list`

Feladatok listázása.

Shell

wp queuety list [--queue=<queue>] [--status=<status>] [--format=<format>]

Beállítás	Leírás
`--queue=<queue>`	Szűrés várólista szerint
`--status=<status>`	Szűrés állapot szerint (`pending`, `processing`, `completed`, `failed`, `buried`)
`--format=<format>`	Kimeneti formátum: `table` (alapértelmezett), `json`, `csv`, `yaml`

`wp queuety inspect`

Feladat teljes részleteinek megjelenítése, beleértve a hasznos adatot és a naplóelőzményeket.

Shell

wp queuety inspect <id>

Beállítás	Leírás
`<id>`	Feladatazonosító (kötelező)

`wp queuety retry`

Adott feladat újrapróbálása.

Shell

wp queuety retry <id>

Beállítás	Leírás
`<id>`	Újrapróbálandó feladatazonosító (kötelező)

`wp queuety retry-buried`

Az összes eltemetett feladat újrapróbálása.

Shell

wp queuety retry-buried

`wp queuety bury`

Feladat kézi eltemetése.

Shell

wp queuety bury <id>

Beállítás	Leírás
`<id>`	Eltemetendő feladatazonosító (kötelező)

`wp queuety delete`

Feladat törlése.

Shell

wp queuety delete <id>

Beállítás	Leírás
`<id>`	Törlendő feladatazonosító (kötelező)

`wp queuety recover`

Elavult, processing állapotban elakadt feladatok helyreállítása.

Shell

wp queuety recover

`wp queuety purge`

Befejezett feladatok törlése.

Shell

wp queuety purge [--older-than=<days>]

Beállítás	Leírás
`--older-than=<days>`	N napnál régebbi feladatok törlése (alapértelmezett: `QUEUETY_RETENTION_DAYS`)

`wp queuety pause`

Szüneteltesse a sort, hogy a munkások kihagyják.

Shell

wp queuety pause <queue>

Beállítás	Leírás
`<queue>`	Szüneteltetendő várólista neve (kötelező)

`wp queuety resume`

Folytassa a szüneteltetett sort.

Shell

wp queuety resume <queue>

Beállítás	Leírás
`<queue>`	Újraindítandó várólista neve (kötelező)

`wp queuety metrics`

Kezelőnkénti metrikák megjelenítése.

Shell

wp queuety metrics [--minutes=<minutes>] [--format=<format>]

Beállítás	Leírás
`--minutes=<minutes>`	Időablak percben (alapértelmezett: `60`)
`--format=<format>`	Kimeneti formátum: `table` (alapértelmezett), `json`, `csv`, `yaml`

`wp queuety discover`

Handler osztályok felderítése egy könyvtárban.

Shell

wp queuety discover <directory> <namespace> [--register]

Beállítás	Leírás
`<directory>`	A handler osztályok keresésére szolgáló könyvtár (kötelező)
`<namespace>`	PSR-4 névtérprefix a könyvtárhoz (kötelező)
`--register`	A felderített handlerek tényleges regisztrálása

Munkafolyamat-parancsok

`wp queuety workflow status`

Munkafolyamat állapotának és előrehaladásának megjelenítése.

Shell

wp queuety workflow status <id>

Beállítás	Leírás
`<id>`	Munkafolyamat-azonosító (kötelező)

A status megjeleníti az aktuális lépést, az opcionális lépésnevet, a verzió/hash-metaadatokat, a várakozási módot és a műtermékek összefoglalóját, valamint egy WaitInfo JSON blobot, ha a munkafolyamatot éppen jelzések vagy függőségek blokkolják.

`wp queuety workflow list`

Munkafolyamatok listázása.

Shell

wp queuety workflow list [--status=<status>] [--format=<format>]

Beállítás	Leírás
`--status=<status>`	Szűrés állapot szerint: `running`, `completed`, `failed`, `paused`, `waiting_for_signal`, `waiting_for_workflows`, `cancelled`
`--format=<format>`	Kimeneti formátum: `table` (alapértelmezett), `json`, `csv`, `yaml`

A parancs legfeljebb 50 munkafolyamatot ad vissza. Beolvassa a --limit értéket, de a WP-CLI jelenleg elutasítja a jelzőt, mert a parancs nem deklarálja azt (#12); másik korláthoz használd a Queuety::list_workflows() értéket.

Az alapértelmezett táblázat tartalmazza a StepName és a WaitMode értéket, így a blokkolt munkafolyamatok könnyebben áttekinthetők.

`wp queuety workflow retry`

Sikertelen munkafolyamat újrapróbálása a meghiúsult lépéstől.

Shell

wp queuety workflow retry <id>

Beállítás	Leírás
`<id>`	Munkafolyamat-azonosító (kötelező)

`wp queuety workflow approve`

Jóváhagyási jelzés küldése egy munkafolyamatnak.

Shell

wp queuety workflow approve <id> [--data=<json>] [--signal=<name>]

Beállítás	Leírás
`<id>`	Munkafolyamat-azonosító (kötelező)
`--data=<json>`	Opcionális JSON objektumadat
`--signal=<name>`	A jóváhagyási jelzés nevének felülírása (alapértelmezett: `approval`, amely megfelel a `wait_for_approval()` értéknek; egy `wait_for_decision()` lépés alapértelmezés szerint a `approved` értékre figyel, ezért ott a `--signal=approved` értéket add meg)

`wp queuety workflow reject`

Elutasítási jelzés küldése egy munkafolyamatnak.

Shell

wp queuety workflow reject <id> [--data=<json>] [--signal=<name>]

Beállítás	Leírás
`<id>`	Munkafolyamat-azonosító (kötelező)
`--data=<json>`	Opcionális JSON objektumadat
`--signal=<name>`	Az elutasítási jelzés nevének felülírása (alapértelmezett: `rejected`)

`wp queuety workflow input`

Strukturált bemenet küldése egy munkafolyamatnak.

Shell

wp queuety workflow input <id> [--data=<json>] [--signal=<name>]

Beállítás	Leírás
`<id>`	Munkafolyamat-azonosító (kötelező)
`--data=<json>`	Opcionális JSON objektumadat
`--signal=<name>`	A bemeneti jelzés nevének felülírása (alapértelmezett: `input`)

`wp queuety workflow artifacts`

Munkafolyamat tárolt műtermékeinek listázása.

Shell

wp queuety workflow artifacts <id> [--format=<format>] [--with-content]

Beállítás	Leírás
`<id>`	Munkafolyamat-azonosító (kötelező)
`--format=<format>`	Kimeneti formátum: `table` (alapértelmezett) vagy `json`
`--with-content`	A műtermék tartalmának felvétele a kimenetbe

`wp queuety workflow artifact`

Egy munkafolyamat egyetlen tárolt műtermékének megjelenítése.

Shell

wp queuety workflow artifact <id> <key>

Beállítás	Leírás
`<id>`	Munkafolyamat-azonosító (kötelező)
`<key>`	Műtermékkulcs (kötelező)

`wp queuety workflow pause`

Futó munkafolyamat szüneteltetése.

Shell

wp queuety workflow pause <id>

Beállítás	Leírás
`<id>`	Munkafolyamat-azonosító (kötelező)

`wp queuety workflow resume`

Szüneteltetett munkafolyamat folytatása.

Shell

wp queuety workflow resume <id>

Beállítás	Leírás
`<id>`	Munkafolyamat-azonosító (kötelező)

`wp queuety workflow cancel`

Olyan munkafolyamat megszakítása, amelynek állapota még nem completed vagy cancelled. Egyetlen tranzakcióban a Queuety az állapotot cancelled értékre állítja, eltemeti a munkafolyamat függő és feldolgozás alatt álló feladatait, és naplózza a workflow_cancelled értéket; ezután lefuttatja a kompenzációkat és a regisztrált takarító handlert.

Shell

wp queuety workflow cancel <id>

Beállítás	Leírás
`<id>`	Megszakítandó munkafolyamat-azonosító (kötelező)

Shell

wp queuety workflow cancel 42

`wp queuety workflow timeline`

Munkafolyamat esemény-idővonalának megjelenítése. Megjeleníti az összes lépéseseményt (elindult, befejeződött, meghiúsult), időbélyeggel, handlerrel és időtartammal együtt.

Shell

wp queuety workflow timeline <id> [--limit=<limit>] [--offset=<offset>] [--format=<format>]

Beállítás	Leírás
`<id>`	Munkafolyamat-azonosító (kötelező)
`--limit=<limit>`	Visszaadandó események maximális száma (alapértelmezett: `100`)
`--offset=<offset>`	Kihagyandó korábbi események száma (alapértelmezett: `0`)
`--format=<format>`	Kimeneti formátum: `table` (alapértelmezett), `json`, `csv`, `yaml`

Shell

wp queuety workflow timeline 42

Kimeneti oszlopok: ID, Step, Event, Handler, Duration_ms, Error, Created_at.

`wp queuety workflow state-at`

Egy adott munkafolyamat-lépés befejeződése vagy folytatása utáni nyilvános munkafolyamat-állapot megjelenítése.

Shell

wp queuety workflow state-at <id> <step>

Beállítás	Leírás
`<id>`	Munkafolyamat-azonosító (kötelező)
`<step>`	Lépésindex, 0-tól számozva (kötelező)

Shell

wp queuety workflow state-at 42 0

A részletekért lásd a Munkafolyamat-eseménynaplót: itt olvashatod el, mi kerül rögzítésre, és milyen esetekben hasznos.

`wp queuety workflow rewind`

Munkafolyamat visszaállítása egy korábbi lépésre, majd folytatása az azt követő lépéstől. Az állapot az adott lépéshez tartozó eseménynapló state_after értékéből áll helyre, és a következő lépés (<step> + 1) kerül sorba; a megadott lépés nem fut le újra.

Shell

wp queuety workflow rewind <id> <step>

Beállítás	Leírás
`<id>`	Munkafolyamat-azonosító (kötelező)
`<step>`	Visszaállítási lépés indexe, 0-tól számozva (kötelező)

Shell

wp queuety workflow rewind 42 1

Részletekért lásd az Időutazás című részt.

`wp queuety workflow fork`

Futó munkafolyamat elágaztatása annak aktuális állapotából kiinduló, független másolattá. Az elágaztatott munkafolyamat új azonosítót kap, és önállóan folytatódik.

Shell

wp queuety workflow fork <id>

Beállítás	Leírás
`<id>`	Elágaztatandó munkafolyamat-azonosító (kötelező)

Shell

wp queuety workflow fork 42
# Success: Workflow #42 forked. New workflow ID: 43.

Részletekért lásd az Elágaztatás című részt.

`wp queuety workflow export`

Munkafolyamat teljes végrehajtási előzményeinek exportálása ide: JSON. Tartalmazza a munkafolyamat sorát, a feladatokat, a munkafolyamat-eseményeket, a naplóbejegyzéseket, a tárolt jelzéseket és a munkafolyamat függőségeire való várakozásokat.

Shell

wp queuety workflow export <id> [--output=<file>]

Beállítás	Leírás
`<id>`	Munkafolyamat-azonosító (kötelező)
`--output=<file>`	A fájl elérési útja, ahová a JSON kerül. Alapértelmezés szerint a szabványos kimenet.

Shell

# Print to stdout
wp queuety workflow export 42

# Write to a file
wp queuety workflow export 42 --output=/tmp/workflow-42.json

Az JSON felépítéséről részletekért lásd az Exportálás és visszajátszás című részt.

`wp queuety workflow replay`

Exportált munkafolyamat visszajátszása egy JSON fájlból. Új munkafolyamatot hoz létre az exportált állapottal, metaadatokkal és előzmény-idővonallal.

Shell

wp queuety workflow replay <file>

Beállítás	Leírás
`<file>`	Az exportált JSON fájl elérési útja (kötelező)

Shell

wp queuety workflow replay /tmp/workflow-42.json
# Success: Workflow replayed. New workflow ID: 85.

Részletekért lásd: Exportálás és visszajátszás.

Ütemezési parancsok

`wp queuety schedule list`

Összes ismétlődő ütemezés listázása.

Shell

wp queuety schedule list [--format=<format>]

Beállítás	Leírás
`--format=<format>`	Kimeneti formátum: `table` (alapértelmezett), `json`, `csv`, `yaml`

`wp queuety schedule add`

Ismétlődő ütemezés hozzáadása.

Shell

wp queuety schedule add <handler> [--every=<interval>] [--cron=<expression>] [--payload=<json>] [--queue=<queue>]

Beállítás	Leírás
`<handler>`	Handler neve vagy osztálya (kötelező)
`--every=<interval>`	Időközkifejezés (e.g. `1 hour`, `30 minutes`)
`--cron=<expression>`	Cron kifejezés (e.g. `0 3 * * *`)
`--payload=<json>`	JSON adat (alapértelmezett: `{}`)
`--queue=<queue>`	Várólista neve (alapértelmezett: `default`)

Meg kell adnod a --every vagy a --cron egyikét.

Shell

wp queuety schedule add cleanup_handler --every="1 hour"
wp queuety schedule add nightly_report --cron="0 3 * * *" --queue=reports

`wp queuety schedule remove`

Ütemezés eltávolítása handlernév alapján.

Shell

wp queuety schedule remove <handler>

Beállítás	Leírás
`<handler>`	Eltávolítandó handler neve (kötelező)

`wp queuety schedule run`

Ütemező ciklusának kézi indítása. Feladatokat helyez sorba az összes esedékes ütemezéshez.

Shell

wp queuety schedule run

Naplóparancsok

`wp queuety log`

Naplóbejegyzések lekérdezése.

Shell

wp queuety log [--job=<id>] [--workflow=<id>] [--handler=<name>] [--event=<event>] [--since=<datetime>] [--limit=<n>] [--format=<format>]

Beállítás	Leírás
`--job=<id>`	Szűrés feladatazonosító szerint
`--workflow=<id>`	Szűrés munkafolyamat-azonosító szerint
`--handler=<name>`	Szűrés handlernév szerint
`--event=<event>`	Szűrés eseménytípus szerint (`started`, `completed`, `failed`, `buried`, `retried`, `workflow_started`, `workflow_completed`, `workflow_failed`, `workflow_paused`, `workflow_resumed`, `workflow_cancelled`, `workflow_rewound`, `workflow_forked`, `workflow_deadline_exceeded`, `debug`)
`--since=<datetime>`	Bejegyzések megjelenítése ettől a dátum-időponttól
`--limit=<n>`	Megjelenítendő bejegyzések maximális száma (alapértelmezett: `50`)
`--format=<format>`	Kimeneti formátum: `table` (alapértelmezett), `json`, `csv`, `yaml`

A szűrők nem kombinálhatók: a Queuety az első megadott szűrőt alkalmazza, a következő sorrendben: --job, --workflow, --handler, --event, --since. A --job és a --workflow az összes bejegyzést adja vissza, a legrégebbivel kezdve, és figyelmen kívül hagyja a --limit értéket. A --handler és a --event az újabb bejegyzésekkel kezdve adja vissza az eredményeket. Szűrő nélkül a parancs az elmúlt 24 órát olvassa be; ez a lekérdezés és a --since a legrégebbi bejegyzésekkel kezdve listáz, így a --limit az időablak legrégebbi bejegyzéseit tartja meg.

Shell

# Logs from the last 24 hours (oldest first)
wp queuety log

# Logs for a job
wp queuety log --job=42

# Failed events
wp queuety log --event=failed --limit=100

# Logs since a specific time
wp queuety log --since="2025-03-01 00:00:00"

Naplók törlése

A LogCommand egy purge alparancsot (wp queuety log purge --older-than=<days>) definiál, de a WP-CLI egyetlen parancsként regisztrálja a wp queuety log elemet, ezért az alparancs nem érhető el, és a következő hibával meghiúsul: „Too many positional arguments: purge” (#11). Ehelyett a régi naplóbejegyzéseket innen töröld: PHP:

Shell

wp eval 'echo Queuety\Queuety::purge_logs( 30 );'

Webhook-parancsok

`wp queuety webhook add`

Webhook URL regisztrálása egy eseményhez.

Shell

wp queuety webhook add <event> <url>

Lehetőség	Leírás
`<event>`	Esemény neve: `job.completed`, `job.failed`, `job.buried` vagy `workflow.failed` (kötelező)
`<url>`	URL, ahová POST értesítéseket kell küldeni (kötelező)

Shell

wp queuety webhook add job.buried https://hooks.slack.com/services/...

`wp queuety webhook list`

Összes regisztrált webhook listázása.

Shell

wp queuety webhook list [--format=<format>]

Beállítás	Leírás
`--format=<format>`	Kimeneti formátum: `table` (alapértelmezett), `json`, `csv`, `yaml`

`wp queuety webhook remove`

Webhook eltávolítása azonosító alapján.

Shell

wp queuety webhook remove <id>

Beállítás	Leírás
`<id>`	Eltávolítandó webhook-azonosító (kötelező)