CLI

Zobraziť ako Markdown Upraviť na GitHub Dokumentácia na 7a44bd6

Rudel registruje svoje príkazy pod wp rudel. WP-CLI odmietne možnosť, ktorú príkaz neuvádza tu, chybou unknown --<name> parameter.

Koreňový príkaz môžete pre vložené použitie premenovať tak, že pred načítaním pluginu definujete RUDEL_CLI_COMMAND v wp-config.php.

PHP

define( 'RUDEL_CLI_COMMAND', 'sandbox' );

Tým sa wp rudel create zmení na wp sandbox create. Správanie príkazu sa nezmení.

Príkazy sa štandardne spúšťajú na hostiteľskom prostredí. Ak chcete spustiť akýkoľvek iný príkaz WP-CLI v sandboxe, nastavte RUDEL_ENVIRONMENT:

Shell

RUDEL_ENVIRONMENT=alpha-3be7 wp option get blogname

create

Shell

wp rudel create [--name=<name>] [--theme=<slug>] [--clone-from=<id>] [--owner=<owner>] [--labels=<labels>] [--purpose=<purpose>] [--protected] [--ttl-days=<days>] [--expires-at=<timestamp>] [--git=<remote>] [--type=<theme|plugin>] [--template=<label>]

Vytvorí sandbox a vypíše jeho ID.

Možnosť	Význam
`--name`	Čitateľný názov. ID tvorí názov a štyri hexadecimálne znaky. Štandardne sa použije názov repozitára s `--git`, inak `sandbox`.
`--theme`	Téma, ktorá sa skopíruje do sandboxu. Musí byť nainštalovaná na hostiteľskom prostredí. Štandardne sa použije aktívna téma hostiteľského prostredia alebo téma zdrojového sandboxu s `--clone-from`.
`--clone-from`	Naklonuje tabuľky a tému z existujúceho sandboxu namiesto hostiteľského prostredia.
`--owner`, `--labels`, `--purpose`	Metadáta. Štítky sa oddeľujú čiarkami.
`--protected`	Vylúči sandbox z čistenia.
`--ttl-days`	Čas vypršania platnosti počítaný od vytvorenia.
`--expires-at`	Konkrétna časová značka vypršania platnosti.
`--git`	Naklonuje vzdialený repozitár do adresára sandboxu. Pozrite si Git.
`--type`	Kam sa vykoná checkout `--git`: `theme` (predvolene) alebo `plugin`.
`--template`	Štítok uložený v zázname; predvolene `blank`. Nenačíta uloženú šablónu.

--clone-db, --clone-themes, --clone-plugins, --clone-uploads, --clone-all, --shared-plugins a --shared-uploads sú zastarané. Menia iba správy o priebehu: každé sandboxové prostredie klonuje tabuľky, kopíruje jednu tému a zdieľa pluginy a nahrané súbory.

Príkaz na záver zobrazí pokyn, aby ste prešli do adresára sandboxu pomocou cd a spustili wp post list. Ten sa spustí v hostiteľskom prostredí, pretože wp-cli.yml v adresári sandboxu odkazuje na hostiteľské URL. Namiesto toho použite RUDEL_ENVIRONMENT.

list

Shell

wp rudel list [--format=<table|json|csv|yaml|count>]

Vypíše sandboxy s ich ID, názvom, vlastníkom, ochranou, vypršaním platnosti, stavom, označením šablóny, časom vytvorenia a veľkosťou adresára.

info

Shell

wp rudel info <id> [--format=<table|json|yaml>]

Zobrazí záznam jedného sandboxu vrátane prefixu tabuliek, témy, štítkov, metadát klonovania, URL a cesty k obsahu.

update

Shell

wp rudel update <id> [--owner=<owner>] [--labels=<labels>] [--purpose=<purpose>] [--protected] [--unprotected] [--ttl-days=<days>] [--expires-at=<timestamp>] [--clear-expiry]

Aktualizuje metadáta. --ttl-days počíta čas odteraz. Obsah webu sandboxu sa nezmení.

destroy

Shell

wp rudel destroy <id> [--force]

Odstráni tabuľky sandboxu, jeho adresár a prepojené pracovné stromy a vymaže jeho záznam. Príkaz si vyžiada potvrdenie; --force preskočí výzvu. Ochrana nebráni destroy: chránený sandbox sa odstráni rovnako ako každý iný.

status

Shell

wp rudel status

Vypíše tabuľku so stavom inicializácie, aktuálnym sandboxom, adresárom sandboxov, počtom sandboxov, hodnotami rudel_config a informáciou, či je naplánovaná automatizácia. Vždy vypíše tabuľku a ignoruje --format.

cleanup

Shell

wp rudel cleanup [--dry-run] [--max-age-days=<days>] [--max-idle-days=<days>] [--merged]

Bez možnosti --merged odstráni nechránené sandboxy, ktorým vypršala platnosť, ktoré prekročili vekový limit alebo boli neaktívne dlhšie než povolený čas. --max-age-days a --max-idle-days majú pri tomto spustení prednosť pred rudel_config. S možnosťou --merged odstráni sandboxy, ktorých prepojené vetvy pracovných stromov Git boli zlúčené. Chránené sandboxy sa vždy preskočia. Pozrite si časť Čistenie.

logs

Shell

wp rudel logs <id> [--lines=<lines>] [--follow] [--clear]

Vypíše posledné riadky protokolu sandboxu debug.log (predvolene 50). --follow spustí tail -f; --clear vyprázdni súbor. Pozrite si časť Zaznamenávanie chýb.

snapshot

Shell

wp rudel snapshot <id> --name=<name>

Vytvorí pomenovanú snímku.

restore

Shell

wp rudel restore <id> --snapshot=<name> [--force]

Obnoví snímku. Príkaz si vyžiada potvrdenie; --force preskočí výzvu. Pozrite si časť Snímky.

template

Shell

wp rudel template save <id> --name=<name> [--description=<description>]
wp rudel template list [--format=<table|json|csv|yaml|count>]
wp rudel template delete <name> [--force]

Ukladá, vypisuje a odstraňuje kópie šablón. Žiadny príkaz nevytvorí sandbox z uloženej šablóny. Pozrite si časť Šablóny.

push

Shell

wp rudel push <id> [--git=<remote>] [--dir=<dir>] [--message=<message>]

Potvrdí zmeny a odošle checkout v adresári sandboxu do vetvy rudel/<id>.

Možnosť	Význam
`--git`	Vzdialené úložisko URL. Potrebné iba vtedy, ak nie je uložené; po prvom úspešnom odoslaní sa zapamätá.
`--dir`	Adresár relatívny k adresáru sandboxu, napríklad `themes/my-theme`. Predvolene sa použije uložený adresár checkoutu, inak celý adresár sandboxu.
`--message`	Správa commitu; predvolene `Update from Rudel sandbox`.

Pozrite si Git.