wp-cli – die Basics

wp-cli ist ein sehr leistungsstarker Werkzeugkasten für Leute, die eine WordPress-Website zu administrieren haben. Es stellt ein Kommandozeilenprogramm bereit, mit dem Änderungen an einer WordPress-Installation auf dem lokalen Rechner oder einem Server im weit entfernten Rechenzentrum durchgeführt werden können.

Um wp-cli nutzen zun können, muss es auf dem lokalen Rechner (und ggf. auf dem entfernten Server) installiert sein. Das passiert mit dem „Vierzeiler“, ausgeführt im Terminal:

mkdir -p ~/.local/bin
curl -o ~/.local/bin/wp \
  https://raw.githubusercontent.com/wp-cli/builds/gh-pages/phar/wp-cli.phar
chmod 0755 ~/.local/bin/wp

Anmerkung: Der Ordner $HOME/.local/bin ist laut XDG Base Directory Specification der Ort, an dem lokale Befehle installiert werden sollen. Falls $HOME/.local/bin noch nicht in $PATH enthalten ist, sollte das schnell nachgeholt werden:

echo "export PATH=\$PATH:\$HOME/.local/bin" >> ~/.bashrc
. ~/.bashrc

Nun steht das Kommando wp bereit. Hier ein paar gern genutzte Aufrufe:

$ wp --path=/path/to/wordpresssite core version
5.2.3
$ cd /path/to/wordpresssite
$ wp plugin list
+-----------------------+--------+--------+---------+
| name                  | status | update | version |
+-----------------------+--------+--------+---------+
| contact-form-7        | active | none   | 5.1.4   |
...
$ wp db export "wp-$(date +'%Y%M%d-%H%m%S').sql"
Success: Exported to 'wp-20191411-060908.sql'.

Die Argumentliste des wp-Kommando besteht immer aus command und action sowie kontextabhängigen Optionen und weiteren Argumenten:

wp <command> <action> [--options] <arguments>

Wird action weggelassen, dan liefert der Befehl eine ausführliche Liste möglicher Aktionen. Mit dem Kommando help und dem eigentlichen command als action wird die man-Page zu dem Kommando angezeigt:

wp help <command>

Der Kommandoaufruf mit command und action sowie der Option --help zeigt die man-Page zu der Aktion.

wp <command> <action> --help

wp-cli sucht sich in folgender Reihenfolge die Argumente zusammen:

• Kommandozeilenargumente beim Programmaufruf,
• Angaben in Datei wp-cli.local.yml im aktuellen oder einem darüber gelegenen Verzeichnis,
• Angaben in Datei wp-cli.yml im aktuellen oder einem darüber gelegenen Verzeichnis,
• Angaben in Datei ~/.wp-cli/config.yml (der Pfad kann mit der Umgebungsvariable WP_CLI_CONFIG_PATH geändert werden),
• Eingebaute Vorgabewerte.

Soweit zu den Basicss, im nächsten Beitrag wird die Installtion einer WordPress-Site mit wp-cli beschrieben.