WP-CLI The command line interface for WordPress

WP-CLI ist eine Sammlung von Kommandozeilen-Tools zur Verwaltung von WordPress Installationen. Du kannst Plugins aktualisieren, Multisite Installationen konfigurieren und vieles mehr, ohne einen Browser zu verwenden.

Um stets auf dem Laufenden zu bleiben, folge @wpcli auf Twitter oder abonniere den Newsletter.

Build Status Abhängigkeiten Status Durchschnittliche Zeit bis zur Lösung eines Issues Prozentsatz noch offener Issues

Quick links: Benutzung | Installation | Support | Erweitern | Mitwirken | Credits

Benutzung

Das Ziel von WP-CLI ist es, für jede Aktion ein Kommandozeilen-Interface zur Verfügung zu stellen, die man auch über den Adminbereich ausführen kann. Mit wp plugin install --activate (doc) kann man zum Beispiel ein WordPress Plugin installieren und aktivieren:

$ wp plugin install rest-api --activate
Installing WordPress REST API (Version 2) (2.0-beta13)
Downloading install package from https://downloads.wordpress.org/plugin/rest-api.2.0-beta13.zip...
Unpacking the package...
Installing the plugin...
Plugin installed successfully.
Activating 'rest-api'...
Success: Plugin 'rest-api' activated.

WP-CLI enthält auch Befehle für viele Dinge, die man im Adminbereich nicht tun kann. Mit wp transient delete-all (doc) kannst du z.B. bestimmte oder alle Transients löschen:

$ wp transient delete-all
Success: 34 transients deleted from the database.

Für eine umfassendere Einführung in die Benutzung von WP-CLI, lies am besten den Quick Start guide.

Bereits genug von den Basics? Sieh dir die komplette Liste an Befehlen an für detailliertere Informationen zur Verwaltung von Themes und Plugins, Datenimport und -export, Suchen/Ersetzen-Operationen in der Datenbank und mehr.

Installation

Das Herunterladen der Phar Datei ist unsere empfohlene Installationsweise. Falls nötig, gibt es auch eine Dokumentation zu alternativen Installationsmethoden.

Bevor du WP-CLI installierst, stell bitte sicher, dass dein System die Mindestanforderungen erfüllt:

Sobald du die Mindestanforderungen geprüft hast, lade die wp-cli.phar Datei mittels wget oder curl herunter:

$ curl -O https://raw.githubusercontent.com/wp-cli/builds/gh-pages/phar/wp-cli.phar

Prüfe als nächstes, ob es funktioniert:

$ php wp-cli.phar --info

Um WP-CLI auf der Kommandozeile durch blosses Tippen von wp zu nutzen, mache die Datei ausführbar und verschiebe es irgendwo hin innerhalb deines PATH. Zum Beispiel:

$ chmod +x wp-cli.phar
$ sudo mv wp-cli.phar /usr/local/bin/wp

Wenn WP-CLI erfolgreich installiert wurde, solltest du bei der Ausführung von wp --info etwas wie hier sehen:

$ wp --info
PHP binary:    /usr/bin/php5
PHP version:    5.5.9-1ubuntu4.14
php.ini used:   /etc/php5/cli/php.ini
WP-CLI root dir:        /home/wp-cli/.wp-cli
WP-CLI packages dir:    /home/wp-cli/.wp-cli/packages/
WP-CLI global config:   /home/wp-cli/.wp-cli/config.yml
WP-CLI project config:
WP-CLI version: 0.25.0

Aktualisieren

Du kannst WP-CLI mittels wp cli update (doc) aktualisieren oder indem du die obigen Installationsschritte wiederholst.

Lebst du gerne gefährlich? Führe wp cli update --nightly aus um den aktuellsten Nightly Build von WP-CLI zu nutzen. Der Nightly Build ist mehr oder weniger stabil genug für die Nutzung in deiner Entwicklungsumgebung und enthält jeweils die neusten und besten Features von WP-CLI.

Tab-Vervollständigung

Für WP-CLI gibt es auch ein Skript zur Autovervollständigung von Befehlen für Bash und ZSH. Lade einfach wp-completion.bash herunter und referenziere es in der ~/.bash_profile Datei:

source /FULL/PATH/TO/wp-completion.bash

Vergiss nicht, danach source ~/.bash_profile auszuführen.

Support

Die Betreuer und Mitwirkenden hinter WP-CLI sind Freiwillige und haben nur begrenzt Zeit um generelle Supportanfragen zu beantworten. Prüfe zunächst, ob es bereits an einem dieser Orte eine Antwort auf deine Frage gibt:

Wenn du auf keiner dieser Seiten eine Antwort finden kannst, trete dem #cli Channel des WordPress.org Slack Teams bei um zu sehen, ob ein Community-Mitglied dir weiterhelfen kann. Professionelle Benutzer können auch runcommand für Premium Support in Betracht ziehen.

GitHub Issues sind nur für das Verwalten von Erweiterungen und Bugs existierender Befehle gedacht, nicht allgemeinen Support. Schau dir unsere Best Practices an, bevor du einen Bug meldest, damit dein Issue in angemessener Zeit bearbeitet werden kann.

Bitte stell keine Supportfragen auf Twitter. Twitter ist kein akzeptabler Ort für Support weil: 1) es ist schwierig Konversationen unter 140 Zeichen zu führen und 2) Twitter ist kein Ort, wo jemand mit der gleichen Frage frühere Antworten in einer Konversation finden kann.

Denk daran, frei != gratis. Die Open Source Lizenz garantiert dir die Freiheit zur Nutzung und Bearbeitung, aber nicht anderer Leute Zeit. Bitte sei respektvoll und setze deine Erwartungen dementsprechend.

Erweitern

Ein Befehl ist die atomare Einheit der WP-CLI Funktionalität. wp plugin install (doc) ist ein solcher Befehl. wp plugin activate (doc) ein anderer.

WP-CLI unterstützt das Registrieren jeder aufrufbaren Klasse, Funktion oder Closure als Befehl. Es liest die Informationen zur Nutzung aus der PHPdoc des Callbacks aus. WP_CLI::add_command() (doc) wird sowohl für die Registration interner Befehle als auch für Befehle von Dritten verwendet.

/**
 * Delete an option from the database.
 *
 * Returns an error if the option didn't exist.
 *
 * ## OPTIONS
 *
 * <key>
 * : Key for the option.
 *
 * ## EXAMPLES
 *
 *     $ wp option delete my_option
 *     Success: Deleted 'my_option' option.
 */
$delete_option_cmd = function( $args ) {
	list( $key ) = $args;

	if ( ! delete_option( $key ) ) {
		WP_CLI::error( "Could not delete '$key' option. Does it exist?" );
	} else {
		WP_CLI::success( "Deleted '$key' option." );
	}
};
WP_CLI::add_command( 'option delete', $delete_option_cmd );

WP-CLI enthält Dutzende Befehle. Es ist auch sehr einfach eigene Befehle zu erstellen. Lies dazu das Commands Cookbook um mehr zu erfahren. Stöbere in der internen API-Dokumentation um eine Vielzahl hilfreicher Funktionen zu entdecken, welche du in deinem eigenen WP-CLI Befehl nutzen kannst.

Mitwirken

Willkommen und danke!

Wir schätzen es sehr, dass du interessiert bist an WP-CLI mitzuwirken. Nur wegen dir und der Community um dich herum ist WP-CLI so ein tolles Projekt.

Mitwirken beschränkt sich nicht nur aufs Programmieren. Wir möchten dich dazu ermutigen, das beizutragen, was du am besten kannst. Sei es durch das Schreiben von Tutorials, das Vorstellen von WP-CLI an einem lokalen Meetup, anderen Nutzern bei ihren Supportfragen zu helfen oder unsere Dokumentation zu pflegen.

Nimm dir bitte einen Moment Zeit um unsere Guidelines in Ruhe durchzulesen. Das Einhalten dieser Guidelines zeigt, dass du die Zeit respektierst, welche andere in dieses Projekt investieren. Im Gegensatz werden andere Betreuer rund um den Globus diesen Respekt erwidern.

Projektleitung

WP-CLI wird von folgenden Personen geleitet:

Lies mehr über die Projektstruktur und schau dir die komplette Liste von Mitwirkenden an.

Credits

Neben den Bibliotheken, die in der composer.json Datei erwähnt werden, nutzen wir Code oder Ideen von folgenden Projekten: