CLI

Visa som Markdown Redigera på GitHub Dokumentation på 7a44bd6

Rudel registrerar sina kommandon under wp rudel. WP-CLI avvisar med unknown --<name> parameter ett alternativ som ett kommando inte listar här.

Du kan byta namn på rotkommandot för inbäddad användning genom att definiera RUDEL_CLI_COMMAND i wp-config.php innan tillägget laddas.

PHP

define( 'RUDEL_CLI_COMMAND', 'sandbox' );

Det ändrar wp rudel create till wp sandbox create. Kommandots beteende ändras inte.

Kommandon körs som standard mot värdsystemet. Om du vill köra ett annat WP-CLI-kommando i en sandlåda anger du 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>]

Skapar en sandlåda och skriver ut dess ID.

Alternativ	Betydelse
`--name`	Läsbart namn. ID:t består av namnet plus fyra hexadecimala tecken. Standardvärdet är arkivets namn med `--git`, annars `sandbox`.
`--theme`	Tema att kopiera till sandlådan. Måste vara installerat på värdsystemet. Standardvärdet är värdsystemets aktiva tema eller källsandlådans tema med `--clone-from`.
`--clone-from`	Klona tabellerna och temat från en befintlig sandlåda i stället för värdsystemet.
`--owner`, `--labels`, `--purpose`	Metadata. Etiketter separeras med kommatecken.
`--protected`	Undanta sandlådan från rensning.
`--ttl-days`	Förfallotid räknad från skapandet.
`--expires-at`	Uttrycklig tidsstämpel för förfallotid.
`--git`	Klona ett fjärrarkiv till sandlådans katalog. Se Git.
`--type`	Var `--git` checkar ut: `theme` (standard) eller `plugin`.
`--template`	En etikett som lagras i posten, standardvärdet `blank`. Den läser inte in en sparad mall.

--clone-db, --clone-themes, --clone-plugins, --clone-uploads, --clone-all, --shared-plugins och --shared-uploads är föråldrade. De ändrar bara förloppsmeddelandena: varje sandlåda klonar tabellerna, kopierar ett tema och delar pluginer och uppladdningar.

Kommandot avslutas med en uppmaning att cd till sandlådans katalog och köra wp post list. Det körs mot värden eftersom wp-cli.yml i sandlådans katalog pekar på värdens URL. Använd RUDEL_ENVIRONMENT i stället.

lista

Shell

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

Visar sandlådor med ID, namn, ägare, skydd, utgångsdatum, status, mallens etikett, skapandetid och katalogstorlek.

info

Shell

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

Visar en sandlådas post, inklusive tabellprefix, tema, etiketter, kloningsmetadata, URL och innehållssökväg.

uppdatera

Shell

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

Uppdaterar metadata. --ttl-days räknas från och med nu. Sandlådans webbplatsinnehåll ändras inte.

förstöra

Shell

wp rudel destroy <id> [--force]

Tar bort sandlådans tabeller, dess katalog och länkade arbetskopior och raderar dess post. Kommandot ber om bekräftelse; --force hoppar över frågan. Skydd hindrar inte destroy: en skyddad sandlåda förstörs precis som alla andra.

status

Shell

wp rudel status

Skriver ut en tabell med bootstrap-tillstånd, aktuell sandlåda, sandlådekatalog, antal sandlådor, värdena för rudel_config och om automatisering är schemalagd. Det skriver alltid ut en tabell och ignorerar --format.

rensa

Shell

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

Utan --merged tas oskyddade sandlådor bort när deras giltighetstid har löpt ut, när de överskrider åldersgränsen eller när de varit inaktiva längre än inaktivitetsgränsen. --max-age-days och --max-idle-days åsidosätter rudel_config för den här körningen. Med --merged tas sandlådor bort vars länkade Git arbetsgrensgrenar har slagits samman. Skyddade sandlådor hoppas alltid över. Se Rensning.

loggar

Shell

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

Skriver ut de sista raderna i sandlådans debug.log (standardvärde 50). --follow kör tail -f; --clear tömmer filen. Se Loggning av fel.

ögonblicksbild

Shell

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

Skapar en namngiven ögonblicksbild.

återställ

Shell

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

Återställer en ögonblicksbild. Kommandot ber om bekräftelse; --force hoppar över frågan. Se Ögonblicksbilder.

mall

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]

Sparar, listar och tar bort mallkopior. Inget kommando skapar en sandlåda från en sparad mall. Se Mallar.

push

Shell

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

Genomför en commit och pushar en arbetskopia i sandlådans katalog till grenen rudel/<id>.

Alternativ	Betydelse
`--git`	Fjärrlagringsplats URL. Behövs bara när ingen är sparad; koms ihåg efter den första lyckade pushen.
`--dir`	Katalog relativt till sandlådans katalog, till exempel `themes/my-theme`. Standard är den sparade arbetskopians katalog, annars hela sandlådans katalog.
`--message`	Commitmeddelande, standardvärde `Update from Rudel sandbox`.

Se Git.