CLI (wd)
Free & Premiumwd ist die Kommandozeile von WebDonkey. Du startest Dienste, legst Sites an, sicherst Datenbanken, liest Logs, führst geplante Aufgaben und Workflows aus und arbeitest mit deinen Servern, direkt aus jedem Terminal. Fast jede Seite der App hat ihre Befehle in wd.
wd verwaltet nichts selbst. Es spricht über einen lokalen Socket mit der laufenden App und ruft dieselben Funktionen auf wie die Oberfläche. Was du mit wd änderst, siehst du sofort in der App, und umgekehrt. Free- und Premium-Grenzen gelten genauso wie im Fenster.
Was du hier machst
- Dienste, Sites, Proxy, Ports und die App steuern, Dateien im WebDonkey Editor öffnen: Grundbefehle
- Datenbanken anlegen, sichern, einspielen und ihre Benutzer verwalten: Datenbanken
- Geplante Aufgaben, Backups, Logs, Zertifikate und abgefangene Mails: Aufgaben, Backups und Logs
- Mit gespeicherten Servern arbeiten: SSH, SFTP, Datenbanken, Logs, Mail, Cronjobs und Backups: Server (Remote)
- Adressen überwachen, Lighthouse und SEO-Prüfungen starten: Monitor und SEO
- Workflows, Notizen, virtuelle Maschinen, KI, MCP, Abonnements, Themes, Einstellungen und Claude Code: Weitere Werkzeuge
- Was für jeden Befehl gilt: Optionen und Exit-Codes
- Einem KI-Agenten beibringen,
wdrichtig zu benutzen: Briefing für KI-Agenten
So kommt wd auf deinen Mac
Du musst nichts installieren. Die App bringt wd mit und legt es bei jedem Start in den Ordner ~/Library/Application Support/WebDonkey/shims/, denselben Ordner, über den auch php und node in deine Shell kommen. Nach einem Update der App ist dort automatisch die neue Version. Damit der Ordner in deinem PATH steht, muss Tools im Terminal eingeschaltet sein (Einstellungen › Sites & Dienste).
- Öffne die Seite Werkzeuge › Terminal.
- Lies in der Karte WebDonkey CLI den Zustand ab.
- Öffne ein neues Terminalfenster und tippe
wd --help.
Die Karte WebDonkey CLI
Die Karte steht oben im Reiter Shell & SSH und fragt eine frische Shell, ob sie wd findet.
| Anzeige oder Knopf | Bedeutung |
|---|---|
| Im PATH gefunden | alles bereit, daneben steht der Pfad, unter dem deine Shell wd findet |
| Nicht im PATH | mit Begründung: Tools im Terminal ist aus, oder deine Shell hat den Ordner noch nicht geladen, oder dieser Build enthält die CLI nicht |
| „Tools im Terminal“ einschalten | erscheint, wenn die Einstellung aus ist, und schaltet sie ein |
| Erneut prüfen | wiederholt den Test, zum Beispiel nach einem neuen Terminalfenster |
| Befehlsübersicht | öffnet diese Doku beim Kapitel CLI |
| Anleitung für KI-Agenten | öffnet das Briefing für KI-Agenten |
| Kopiersymbol | kopiert wd --help in die Zwischenablage |
Darunter stehen vier Beispiele: wd --help, wd, wd services start mysql und wd open toolbox.
Gut zu wissen
- Namen darfst du abkürzen.
wd start myfindetmysql,wd sites open shopdeine Shop-Site. Passen mehrere, fragtwdim Terminal mit einer Auswahl nach. Lässt du den Namen weg, öffnet sich die Auswahl sofort. - Ist die App zu, fragt
wd, ob es sie starten soll. Mit-ystartet es sie ohne Nachfrage, mit--no-launchnie.wd openstartet die App immer, weil der Befehl genau das will. - Rückfragen: Befehle, die etwas löschen oder überschreiben, fragen vorher nach. In Skripten ohne Terminal brauchen sie
-y, sonst brechen sie mit Exit-Code 2 ab, statt still Ja zu sagen. - Sprache: Läuft die App auf Deutsch, antwortet
wdauf Deutsch, sonst auf Englisch. Mit der UmgebungsvariableWD_LANG=enoderWD_LANG=delegst du die Sprache selbst fest. Befehle und Optionen sind in jeder Sprache gleich, die Hilfetexte (--help) sind Englisch. - Für Skripte gibt es bei jedem Befehl
--json, auch für Fehler. Der Exit-Code unterscheidet Erfolg, Fehler, falsche Verwendung, nicht erreichbare App und Premium. Siehe Optionen und Exit-Codes. wderreicht nur das WebDonkey desselben Benutzers auf demselben Mac. Es öffnet keinen Netzwerkport.
Free und Premium
wd selbst ist kostenlos. Jeder Befehl hat dieselben Grenzen wie die Seite, zu der er gehört:
| Bereich | Free | Premium |
|---|---|---|
| Dienste, Sites, Datenbanken, Logs, Zertifikate, Mail, Proxy, App | ja, mit den Grenzen der App (zum Beispiel 6 laufende Dienste, 3 Sites mit HTTPS) | ohne Grenzen |
| Geplante Aufgaben | 3 Aufgaben | beliebig viele |
| Projekt-Backups, Remote, Notizen, eigene Logs | nein | ja |
| Monitor, Abonnements, Workflows | mit den Free-Grenzen der Seiten | ohne Grenzen |
| SEO | mit dem SEO-Paket | mit dem SEO-Paket |
Stößt ein Befehl an eine Grenze, endet er mit Exit-Code 4 und nennt sie. Preise findest du unter webdonkey.io/pricing.
Grundbefehle Free & Premium
Die Grundbefehle von wd decken den Alltag ab: den Überblick, Dienste, Sites, den Front-Proxy, belegte Ports, die App selbst und den WebDonkey Editor. Wo ein <name> steht, darfst du abkürzen. Lässt du ihn weg, öffnet sich im Terminal eine Auswahl. wd <befehl> --help zeigt die Hilfe zu jedem Befehl.
So findest du es
Im Terminal: wd --help listet alle Befehle. In der App öffnet die Karte WebDonkey CLI auf der Seite Werkzeuge › Terminal über Befehlsübersicht diese Doku.
So gehst du vor
Ein PHP-Projekt startklar machen:
wd statuszeigt, was läuft.wd sites create shop.test --path ~/Sites/shop --php 8.3legt die Site an und startet, was sie braucht.wd sites open shopöffnet sie im Browser.- Lädt etwas nicht, zeigt
wd doctordie Ursache samt passendem Befehl.
Überblick und Diagnose
| Befehl | Bedeutung |
|---|---|
wd |
Überblick: Free oder Premium, Version, Front-Proxy, laufende Dienste und Sites. Dasselbe wie wd status |
wd status |
derselbe Überblick, mit --json maschinenlesbar |
wd doctor |
prüft PATH, App, Versionen, abgestürzte Dienste, jede Site (PHP und Webserver laufen?) und den Front-Proxy. Zu jedem Problem steht der Befehl, der es behebt. Exit-Code 1, wenn eine Prüfung fehlschlägt |
wd open <seite> |
holt die App auf einer Seite nach vorn, zum Beispiel wd open toolbox oder wd open "toolbox?tool=json". Ohne Seite: Auswahl |
wd completions <shell> |
gibt die Tab-Vervollständigung für zsh, bash, fish, elvish oder powershell aus. Für zsh: source <(wd completions zsh) in die ~/.zshrc |
wd open kennt diese Seiten: dashboard, sites, certificates, services, configuration, databases, remote-databases, mail, remote-mail, logs, custom-logs, remote-logs, docs, legal, remote, notes, backups, remote-backups, cron, remote-cron, monitor, subscriptions, api-client, workflows, toolbox, ai, claude, terminal, vms, changelog, premium, themes und settings. Dazu die Kurzformen home, config, configs, db, certs, ssl, tasks, scheduled-tasks, api, ki, help und manual. Ist der Name keine Seite, aber eine Site, öffnet wd open die Site im Browser und weist auf wd sites open hin.
Dienste
| Befehl | Bedeutung |
|---|---|
wd services |
installierte Dienste mit Version, Status und Laufzeit, laufende zuerst. Kurzform wd ls, auch wd service |
wd services start <name…> |
Dienste starten, name@version für eine bestimmte installierte Version. Kurzform wd start |
wd services stop <name…> |
Dienste stoppen. Kurzform wd stop |
wd services stop --all |
alle laufenden Dienste stoppen |
wd services restart <name…> |
Dienste neu starten. Kurzform wd restart |
wd services install <name[@version]…> |
Dienste installieren: ohne Version die neueste stabile, sonst genau diese. Kann wegen des Downloads Minuten dauern |
wd services use <name@version> |
die Version festlegen, mit der ein Dienst startet und die neue Terminalfenster nutzen, zum Beispiel php@8.3. Ohne Version: aktive und installierte Versionen anzeigen |
wd services start php startet die Version, die in der App aktiv ist. Laufende Dienste behalten nach wd services use ihre Version, bis du sie neu startest.
Sites
| Befehl | Bedeutung |
|---|---|
wd sites |
alle Sites mit Domain, an oder aus, Webserver, PHP und Pfad. Auch wd site |
wd sites info <site> |
alles zu einer Site: URL, Name, Aliasse, Document-Root, Projektordner, Webserver, PHP, Node, eigener Prozess, SSL, Zertifikat, Umgebungsvariablen |
wd sites start <site> |
Site einschalten und starten, was sie braucht: PHP, Webserver, Datenbanken |
wd sites stop <site> |
Site ausschalten. Die Domain wird frei, Dienste, die andere Sites nutzen, laufen weiter |
wd sites open <site> |
Site im Browser öffnen |
wd sites create <domain> |
Site für einen Ordner anlegen und gleich starten (Optionen unten) |
wd sites delete <site> |
Site löschen: Konfiguration, Zertifikat und Logs. Der Projektordner bleibt. Fragt vorher |
wd sites php <site> <version> |
die Site auf eine installierte PHP-Version festlegen, zum Beispiel wd sites php shop 8.4 |
wd sites node <site> <version> |
dasselbe für Node, zum Beispiel wd sites node app 22 |
wd sites diagnose <site> |
die Prüfungen der Seite Sites: Ordner, vhost, Zertifikat, PHP, Webserver. Exit-Code 1, wenn eine fehlschlägt |
wd sites packages [paket] |
die Site-Pakete (Shopware, WordPress und weitere) mit dem, was sie brauchen. Mit Paketnamen: seine Einstellungen mit Vorgabe und erlaubten Werten |
Optionen von wd sites create
| Option | Bedeutung | Vorgabe |
|---|---|---|
--path <ordner> |
Projektordner, der ausgeliefert wird. ~/ ist erlaubt |
der aktuelle Ordner |
--name <name> |
Anzeigename in der App | die Domain |
--webserver <art> |
nginx, caddy oder apache |
nginx |
--php <version> |
PHP-Version, zum Beispiel 8.3 |
keine, also eine statische Site |
--no-ssl |
HTTP statt HTTPS | HTTPS |
--package <paket> |
ein Site-Paket in den Ordner installieren (Premium) | keins |
--set KEY=WERT |
eine Einstellung des Pakets, mehrfach möglich | die Vorgabe des Pakets |
--overwrite |
das Paket darf Dateien ersetzen, die schon im Ordner liegen | aus |
Startet die neue Site nicht, bleibt sie angelegt, aber ausgeschaltet. wd nennt den Grund und den Befehl wd sites start <domain> für den nächsten Versuch.
Mit --package arbeitet wd wie das Formular der Seite Sites: Es prüft zuerst, ob alles da ist, was das Paket braucht, legt dann die Site an, installiert das Paket und zeigt jeden Schritt. Schlägt die Installation fehl, bleibt die Site bestehen, und du startest die Installation in der App erneut.
Proxy, Ports und App
| Befehl | Bedeutung |
|---|---|
wd proxy |
läuft der Front-Proxy auf den Ports 80 und 443? Dasselbe wie wd proxy status |
wd proxy start, wd proxy stop |
Front-Proxy starten oder stoppen. Ohne ihn antworten deine Sites nicht auf ihren Domains |
wd free-port <port> |
den Prozess beenden, der einen Port belegt, zum Beispiel wd free-port 3306. Fragt vorher |
wd app |
läuft die App? Funktioniert auch, wenn sie zu ist. Dasselbe wie wd app status |
wd app start |
App starten und warten, bis sie antwortet |
wd app stop |
App beenden. Sie stoppt vorher ihre Dienste |
WebDonkey Editor
| Befehl | Bedeutung |
|---|---|
wd edit [pfad…] |
Dateien oder Ordner im WebDonkey Editor öffnen. pfad:zeile oder pfad:zeile:spalte springt dorthin. Ohne Pfad: der aktuelle Ordner. Startet den Editor, wenn er nicht läuft |
wd edit -w <datei> |
wartet, bis du die Datei im Editor wieder schließt. Gedacht für $EDITOR, git commit oder Ctrl+G in Claude Code. Lang: --wait |
wd edit --diff <a> <b> |
zwei Dateien nebeneinander vergleichen |
wd edit --terminal [ordner] |
ein Terminal im Editor öffnen, im angegebenen oder im aktuellen Ordner |
WebDonkey entfernen
| Befehl | Bedeutung |
|---|---|
wd uninstall |
entfernt, was WebDonkey außerhalb seines Datenordners eingerichtet hat: Sudoers-Regeln, Hilfsprogramme, Zeitplan-Dienste, DNS-Dateien, hosts-Einträge, das Vertrauen in die lokale CA, den PATH-Block, die Claude-Statuszeile, Shell-Aliases, SSH-Hosts und den Prompt. Zeigt vorher die Liste und fragt, macOS fragt einmal nach dem Administrator-Passwort, danach beendet sich die App |
wd uninstall --delete-data |
löscht zusätzlich die Daten von WebDonkey (Sites, Datenbanken, Einstellungen), sobald die App beendet ist |
Projektordner fasst wd uninstall nie an. Nutze den Befehl nur, wenn du WebDonkey wirklich entfernen willst, nicht als Reparatur.
Beispiele
wd services start mysql redis
wd start php@8.3
wd services use php@8.4
wd sites create shop.test --php 8.3
wd sites create blog.test --path ~/Sites/blog --package wordpress --set site_title=Blog
wd sites diagnose shop
wd edit src/Checkout.php:42
wd status --json
Free und Premium
- Im Free-Tarif laufen höchstens 6 Dienste gleichzeitig. Weitere Starts enden mit Exit-Code 4 und dem Hinweis
wd services stop <name>. - Im Free-Tarif haben höchstens 3 Sites HTTPS.
wd sites createendet dann mit Exit-Code 4 und dem Hinweis--no-ssl. wd sites create --packagebraucht Premium,wd sites packageszeigt die Pakete auch ohne.
Wenn es nicht klappt
| Was du siehst | Warum | Was du tust |
|---|---|---|
Meldung mit PORT_IN_USE:<port> und dem Hinweis wd free-port <port> |
Ein anderes Programm belegt den Port, oft ein zweiter MySQL- oder Webserver | Prüfen, was es ist, dann wd free-port <port> |
| Port … ist von einem Systemprozess belegt | Der Prozess gehört einem anderen Benutzer oder macOS selbst | Das Programm selbst beenden, WebDonkey kann es nicht |
| Site lädt nicht | Sie ist aus, oder PHP oder der Webserver laufen nicht | wd sites (ist sie an?), dann wd sites diagnose <site> |
Meldung, die Version sei nicht installiert, mit wd services install php@… |
wd sites php nimmt nur installierte Versionen |
Den genannten Befehl ausführen, dann erneut |
| Mehrdeutiger Name in einem Skript | Ohne Terminal kann wd nicht nachfragen |
Den Namen eindeutiger schreiben, die Meldung listet die Kandidaten |
Siehe auch
Datenbanken Free
Mit wd db arbeitest du mit den lokalen Datenbank-Servern von WebDonkey: MySQL, MariaDB, PostgreSQL und MongoDB. Du listest Server und Datenbanken, öffnest den Client, legst Datenbanken an, benennst sie um, sicherst sie, spielst Dumps ein und verwaltest Benutzer und Rechte. Das sind dieselben Aktionen wie auf der Seite Datenbanken.
So findest du es
Im Terminal: wd db --help und wd db users --help. wd databases ist eine andere Schreibweise für wd db.
So gehst du vor
Eine Datenbank für ein neues Projekt anlegen, einen Benutzer dafür einrichten und einen Dump einspielen:
wd dbzeigt, welche Server laufen. Läuft keiner, startest du einen mitwd services start mysql.wd db create mysql shoplegt die Datenbankshopan.printf '%s' "$PW" | wd db users add mysql shop_user --database shop --password-stdinlegt den Benutzershop_useran und gibt ihm alle Rechte aufshop.wd db restore mysql shop ~/Downloads/shop.sql.gzspielt den Dump ein. Der jetzige Inhalt vonshopwird vorher gesichert,wdfragt nach.
Befehle
| Befehl | Bedeutung |
|---|---|
wd db |
Datenbank-Server mit Version, Port und Status, darunter ihre Datenbanken. Datenbanken erscheinen nur, solange ihr Server läuft. Dasselbe wie wd db list |
wd db shell [server] [datenbank] |
öffnet den Client des Servers (mysql, psql, mongosh), schon als root angemeldet. Läuft nur ein Server, darfst du ihn weglassen. Flags für den Client nach --, zum Beispiel wd db shell mysql shop -- -e "SHOW TABLES" |
wd db create <server> <name> |
neue Datenbank auf einem laufenden Server |
wd db drop <server> <name> |
Datenbank mit allen Daten löschen. Fragt vorher, der Name muss genau stimmen |
wd db rename <server> <name> <neuer-name> |
Datenbank umbenennen |
wd db backup <server> <datenbank> |
Datenbank in eine Datei sichern. Format, Dateiname und Ordner wie zuletzt im Backup-Dialog der App gewählt |
wd db restore <server> <datenbank> <datei> |
eine Sicherung in eine Datenbank einspielen. Der jetzige Inhalt wird vorher gesichert, dann ersetzt. Fragt vorher |
<server> ist mysql, mariadb, postgres oder mongodb und darf abgekürzt werden. Der Server muss laufen. Sichern und Einspielen gibt es für MySQL, MariaDB und PostgreSQL.
Optionen von wd db backup
| Option | Bedeutung |
|---|---|
--format <format> |
sql (SQL, gzip-komprimiert), sql_plain (SQL ohne Komprimierung), pg_custom (Archiv von PostgreSQL) oder csv |
--folder <ordner> |
Ordner für die Datei. Ohne: der zuletzt gewählte, sonst der Backup-Ordner der App |
Was du mit --format und --folder angibst, merkt sich die App wie eine Wahl im Dialog.
Optionen von wd db restore
| Option | Bedeutung |
|---|---|
--accept-version-jump |
auch einen Dump von einer anderen Hauptversion des Servers einspielen |
--rewrite-definers |
DEFINER-Angaben in Views, Routinen und Triggern auf den lokalen Benutzer umschreiben |
Die Datei darf SQL, gzip-komprimiertes SQL oder ein PostgreSQL-Archiv sein. Braucht das Einspielen eine dieser Entscheidungen, bricht wd ab und nennt die passende Option.
Benutzer und Rechte
| Befehl | Bedeutung |
|---|---|
wd db users [server] |
Benutzer aller laufenden Server (oder eines) mit Hosts, Rechten je Datenbank und den Sites, die sich damit anmelden. Dasselbe wie wd db users list |
wd db users add <server> <benutzer> --password-stdin |
Benutzer anlegen. Optionen: --database <db> gibt ihm gleich Rechte darauf, --level legt sie fest, --host (nur MySQL und MariaDB) sagt, von wo er sich anmelden darf: localhost (Vorgabe), % für überall oder ein Host |
wd db users grant <server> <benutzer> <datenbank> |
einem Benutzer Rechte auf eine Datenbank geben. Ersetzt, was er dort vorher hatte. --level wie oben, Vorgabe all |
wd db users revoke <server> <benutzer> <datenbank> |
die Rechte auf eine Datenbank entziehen. Fragt vorher |
wd db users password <server> <benutzer> --password-stdin |
neues Passwort setzen |
wd db users delete <server> <benutzer> |
Benutzer löschen. Fragt vorher, Sites, die sich damit anmelden, funktionieren danach nicht mehr |
--level kennt drei Stufen: all (alle Rechte), readwrite (lesen und schreiben) und readonly (nur lesen).
Passwörter nur über stdin. wd nimmt ein Passwort nie als Argument an, damit es weder im Shell-Verlauf noch in der Prozessliste landet. Gib es mit --password-stdin in der ersten Zeile von stdin weiter, zum Beispiel printf '%s' "$PW" | wd db users password mysql shop_user --password-stdin.
Die eigenen Konten des Servers (root, postgres und ähnliche) kannst du mit wd nicht ändern, die App meldet sich mit ihnen an.
Was im Hintergrund passiert
wd db shellersetzt sich durch den Client des Servers. Mit--jsongeht es deshalb nicht.wd db backupundwd db restoreführt die App aus, mit denselben Prüfungen wie die Dialoge der Seite Datenbanken.wdwartet, bis sie fertig sind, auch wenn das länger dauert.- Vor
wd db restorelegt die App eine Sicherung des jetzigen Inhalts im Backup-Ordner ab.
Free und Premium
Alle Befehle auf dieser Seite sind kostenlos.
Wenn es nicht klappt
| Was du siehst | Warum | Was du tust |
|---|---|---|
| Kein Datenbank-Server läuft | Kein Server ist gestartet | wd services start mysql (oder postgres, mariadb) |
Meldung mit remote_db_restore_version_jump und dem Hinweis --accept-version-jump |
Der Dump stammt von einer anderen Hauptversion | Prüfen, ob das gewollt ist, dann mit --accept-version-jump wiederholen |
Meldung mit remote_db_restore_definer und dem Hinweis --rewrite-definers |
Views oder Routinen laufen unter einem Konto, das es lokal nicht gibt | Mit --rewrite-definers wiederholen |
Meldung mit db_system_account |
Du wolltest ein eigenes Konto des Servers ändern | Einen eigenen Benutzer anlegen und den ändern |
| Das Passwort kommt nur über stdin | Das Passwort fehlt oder kam als Argument | Mit --password-stdin und einer Pipe übergeben |
db_not_listed |
Die Datenbank gibt es auf diesem Server nicht | Den Namen mit wd db prüfen, er muss genau stimmen |
Siehe auch
Aufgaben, Backups und Logs Free & Premium
Diese Befehle gehören zu den Seiten Geplante Aufgaben, Backups, Logs, SSL-Zertifikate und Mail der App. Mit wd cron legst du geplante Aufgaben an und führst sie aus, mit wd backup steuerst du Projekt-Backups, mit wd logs liest du Logs, mit wd ssl kümmerst du dich um lokale Zertifikate und mit wd mail liest du die Mails, die Mailpit abgefangen hat.
So findest du es
Im Terminal: wd cron --help, wd backup --help, wd logs --help, wd ssl --help, wd mail --help. Andere Schreibweisen: wd tasks für wd cron, wd backups für wd backup, wd certs und wd certificates für wd ssl, wd mails für wd mail.
So gehst du vor
Eine nächtliche Aufgabe anlegen und sofort einmal testen:
wd cron add cleanup --schedule "0 3 * * *" --command "php bin/console app:cleanup" --dir ~/Sites/shopwd cron run cleanupführt sie jetzt aus und zeigt ihre Ausgabe.wd cronzeigt sie mit Zeitplan, letztem und nächstem Lauf.
Geplante Aufgaben (wd cron)
| Befehl | Bedeutung |
|---|---|
wd cron |
geplante Aufgaben mit Zeitplan, letztem und nächstem Lauf. Dasselbe wie wd cron list |
wd cron run <aufgabe> |
Aufgabe jetzt ausführen, warten und ihre Ausgabe zeigen. Exit-Code 1, wenn der Befehl fehlschlägt |
wd cron enable <aufgabe> |
Aufgabe einschalten, der Zeitplan führt sie wieder aus |
wd cron disable <aufgabe> |
Aufgabe pausieren |
wd cron add <name> --schedule <cron> --command <befehl> |
neue Aufgabe |
wd cron edit <aufgabe> |
Aufgabe ändern, nur was du angibst, ändert sich. An oder pausiert bleibt, wie es war |
wd cron delete <aufgabe> |
Aufgabe löschen. Fragt vorher |
| Option | Bedeutung | Vorgabe |
|---|---|---|
--schedule <cron> |
Zeitplan als Cron-Ausdruck mit fünf Feldern (Minute, Stunde, Tag, Monat, Wochentag), zum Beispiel "*/15 * * * *" |
Pflicht bei add |
--command <befehl> |
Shell-Befehl, läuft über sh -c |
Pflicht bei add |
--dir <ordner> |
Ordner, in dem der Befehl läuft. Relativ heißt: vom aktuellen Ordner aus. Bei edit setzt "" ihn auf deinen Benutzerordner zurück |
dein Benutzerordner |
--paused |
Aufgabe pausiert anlegen (nur add) |
aus |
--name <name> |
neuer Name (nur edit) |
Projekt-Backups (wd backup)
| Befehl | Bedeutung |
|---|---|
wd backup |
Backup-Sets mit Zeitplan, letztem Lauf und Größe. Dasselbe wie wd backup list |
wd backup run <set> |
Backup-Set jetzt ausführen. Kann Minuten dauern. Exit-Code 1, wenn es nicht vollständig gelingt |
wd backup runs <set> |
die Archive eines Sets mit Datum, Größe und Status |
wd backup add <name> |
neues Backup-Set (Optionen unten) |
wd backup edit <set> |
Set ändern, nur was du angibst, ändert sich |
wd backup delete <set> |
Set löschen. Fragt vorher. Die Archive bleiben, außer du gibst --archives an |
| Option | Bedeutung | Vorgabe |
|---|---|---|
--path <pfad> |
Ordner oder Datei, die gesichert wird. Mehrfach möglich | keiner |
--exclude <muster> |
was in jedem Pfad nicht mitgesichert wird, ein Ordnername wie node_modules oder ein Teilpfad wie var/cache. Mehrfach möglich |
keins |
--db [server:]datenbank |
Datenbank, die mit gedumpt wird, Server mysql, mariadb oder postgres. Den Server darfst du weglassen, wenn nur einer die Datenbank hat. Mehrfach möglich |
keine |
--folder <ordner> |
Ordner für die Archive | der Backup-Ordner von WebDonkey |
--default-folder |
Archive wieder in den Backup-Ordner von WebDonkey | |
--schedule <plan> |
off (nur von Hand), hourly, daily, weekly oder custom |
off |
--at HH:MM |
Uhrzeit für daily und weekly |
02:00 |
--weekday <tag> |
Tag für weekly: mon, tue, wed, thu, fri, sat oder sun |
mon |
--cron <ausdruck> |
eigener Cron-Ausdruck, setzt den Plan auf custom |
|
--keep <n> |
wie viele vollständige Backups bleiben, 1 heißt nur das neueste |
10 |
Bei edit ersetzt eine angegebene Liste (--path, --db, --exclude) die alte. Ein einzelnes '' leert sie. Ohne Optionen sichert ein neues Set nichts, läuft nur von Hand und behält 10 Backups.
Logs (wd logs)
| Befehl | Bedeutung |
|---|---|
wd logs |
alle Logs, die WebDonkey kennt, mit ihrer Datei. Dasselbe wie wd logs list |
wd logs tail <name> |
das Ende eines Logs ausgeben. Kurzform wd logs <name> |
wd logs custom |
deine eigenen Logs mit ihrer Datei |
wd logs custom add <name> <datei> |
eine Logdatei unter einem Namen hinzufügen |
wd logs custom tail <name> |
das Ende eines eigenen Logs ausgeben |
wd logs custom clear <name> |
eine eigene Logdatei leeren. Fragt vorher |
wd logs custom remove <name> |
ein eigenes Log aus der Liste nehmen. Die Datei bleibt |
-n <zahl> legt fest, wie viele Zeilen tail ausgibt (Vorgabe 100). -f verfolgt die Datei weiter, bis du mit Ctrl+C abbrichst. Wird die Datei dabei geleert oder rotiert, liest wd von vorn weiter.
Zertifikate (wd ssl)
| Befehl | Bedeutung |
|---|---|
wd ssl |
ob die lokale CA vertrauenswürdig ist, dazu jedes Zertifikat mit Domain, verbleibenden Tagen und weiteren Namen. Weniger als 14 Tage sind gelb markiert. Dasselbe wie wd ssl list |
wd ssl renew <site> |
das Zertifikat einer Site neu ausstellen |
wd ssl trust |
der lokalen CA von WebDonkey im Schlüsselbund vertrauen. macOS fragt nach deinem Passwort |
Mail (wd mail)
| Befehl | Bedeutung |
|---|---|
wd mail |
die neuesten Mails, die Mailpit abgefangen hat, mit Nummer, Absender, Betreff und Alter, darunter die Gesamtzahl und die ungelesenen. Dasselbe wie wd mail list |
wd mail list -n <zahl> |
so viele Mails zeigen (Vorgabe 20) |
wd mail show <nummer> |
eine Mail mit Von, An, Betreff, Datum und Text. 1 ist die neueste. Statt der Nummer geht auch die ID der Mail |
Hat eine Mail nur einen HTML-Teil, verweist wd mail show auf wd open mail. So prüfst du schnell, ob deine Site eine Mail wirklich verschickt hat.
Free und Premium
| Befehle | Free | Premium |
|---|---|---|
wd cron |
3 Aufgaben. Auflisten und Ausführen bestehender Aufgaben ist nie begrenzt | beliebig viele |
wd backup |
nur wd backup delete, für Sets aus einer früheren Premium-Zeit |
alle Befehle |
wd logs, wd logs tail |
ja | ja |
wd logs custom |
nur die Liste | alle Befehle |
wd ssl, wd mail |
ja | ja |
Nach einem Wechsel von Premium zu Free bleiben Aufgaben über der Grenze erhalten, sind aber gesperrt. An einer gesperrten Aufgabe kannst du nur noch den Namen ändern. Wird eine Grenze erreicht, endet der Befehl mit Exit-Code 4.
Wenn es nicht klappt
| Was du siehst | Warum | Was du tust |
|---|---|---|
wd cron run endet mit Exit-Code 1 |
Der Befehl der Aufgabe ist fehlgeschlagen | Die Ausgabe darüber lesen, sie stammt vom Befehl selbst |
wd backup run meldet partial |
Ein Teil ließ sich nicht sichern | wd backup runs <set> und die Meldung prüfen |
Meldung mit mailpit_not_running |
Der Dienst Mailpit läuft nicht | wd services start mailpit |
| Nichts zu ändern | edit ohne Option aufgerufen |
Mindestens eine Option angeben |
wd logs tail -f endet nicht |
So gewollt, -f verfolgt die Datei |
Ctrl+C, in Skripten -n mit fester Zeilenzahl |
Siehe auch
Server (Remote) Premium
Mit wd remote arbeitest du mit den Servern, die du auf der Seite SFTP / SSH gespeichert hast: eine SSH-Sitzung öffnen, die Anmeldung testen, Dateien über SFTP holen und hochladen, Datenbanken auf dem Server sichern und einspielen, Logs lesen, Postfächer ansehen und die Cronjobs und Backups der Server steuern. Alles läuft über dieselben Verbindungen und mit denselben Prüfungen wie in der App. wd remote braucht Premium.
So findest du es
Im Terminal: wd remote --help, für die Bereiche wd remote sftp --help, wd remote db --help und so weiter. wd servers ist eine andere Schreibweise für wd remote.
So gehst du vor
Eine Datei vom Server holen und einen Befehl dort ausführen:
wd remotezeigt deine gespeicherten Verbindungen.wd remote test prodmeldet sich einmal an und zeigt den Startordner.wd remote sftp ls prod wwwlistet den Ordnerwwwim Startordner.wd remote sftp get prod www/.env ./env-prodholt die Datei auf deinen Mac.wd remote ssh prod -- uptimeführtuptimeauf dem Server aus.
Verbindungen
| Befehl | Bedeutung |
|---|---|
wd remote |
gespeicherte Verbindungen mit Host, Benutzer und Anmeldeart. Dasselbe wie wd remote list |
wd remote ssh <name> |
SSH-Sitzung öffnen. Flags und Befehle für ssh nach --, zum Beispiel wd remote ssh prod -- uptime |
wd remote test <name> |
einmal anmelden und den Startordner melden. Beim ersten Kontakt merkt sich WebDonkey den Fingerprint des Servers |
wd remote add <name> --host <host> --user <benutzer> |
neue Verbindung speichern (Optionen unten) |
wd remote delete <name> |
Verbindung samt gespeichertem Geheimnis löschen. Fragt vorher. Abgelehnt, solange aktive Aufgaben, Backups oder Sync-Paare sie nutzen |
Option von add |
Bedeutung | Vorgabe |
|---|---|---|
--host <host> |
Hostname oder IP | Pflicht |
--user <benutzer> |
Login-Benutzer | Pflicht |
--port <port> |
SSH-Port | 22 |
--key <datei> |
mit dieser privaten Schlüsseldatei anmelden | |
--agent |
über den SSH-Agenten anmelden | |
--password-stdin |
Passwort (oder die Passphrase des Keys) aus der ersten Zeile von stdin lesen |
Ohne --key und --agent meldet sich die Verbindung mit Passwort an. Ein Passwort gibst du nie als Argument an, nur über --password-stdin.
Dateien über SFTP (wd remote sftp)
| Befehl | Bedeutung |
|---|---|
wd remote sftp ls <server> [pfad] |
einen Ordner auf dem Server auflisten, mit Rechten, Größe und Alter. Ohne Pfad: der Startordner. Relative Pfade beginnen dort |
wd remote sftp get <server> <entfernt> [lokal] |
Datei oder Ordner herunterladen, ein Ordner kommt ganz. Ohne Ziel: derselbe Name im aktuellen Ordner. Ist das Ziel ein vorhandener Ordner, landet es darin. Fragt, bevor es hier etwas überschreibt |
wd remote sftp put <server> <lokal> [entfernt] |
Datei oder Ordner hochladen. Ohne Ziel: derselbe Name im Startordner. Endet das Ziel auf /, heißt das „in diesen Ordner“. Fragt, bevor es auf dem Server etwas überschreibt |
Datenbanken auf dem Server (wd remote db)
| Befehl | Bedeutung |
|---|---|
wd remote db |
die Einträge der Seite Remote › Datenbanken mit Art, Server, Adresse und Standard-Datenbank |
wd remote db databases <eintrag> |
die Datenbanken, die ein Eintrag erreicht, mit Größe und Zahl der Tabellen |
wd remote db backup <eintrag> [datenbank] |
eine Datenbank in eine Datei auf deinem Mac sichern. Format, Dateiname und Ordner wie zuletzt im Dialog gewählt. Kurzform dump |
wd remote db restore <eintrag> <datenbank> <datei> |
eine Datei in eine Datenbank auf dem Server einspielen. Der jetzige Inhalt wird vorher gesichert, dann ersetzt. Fragt vorher. Kurzform import |
backup kennt --format (sql, sql_plain, pg_custom, csv, json) und --folder. Ohne Datenbank nimmt backup die des Eintrags, sonst fragt es. restore kennt --accept-version-jump und --rewrite-definers, wie bei den lokalen Datenbanken.
Logs auf dem Server (wd remote logs)
| Befehl | Bedeutung |
|---|---|
wd remote logs |
deine Remote-Logs mit Server, Datei, Zeitplan und letztem Lesen |
wd remote logs tail <log> |
das Log jetzt über SSH lesen und das Ende ausgeben, -n Zeilen (Vorgabe 100). Mit -f liest wd alle 5 Sekunden neu, bis du abbrichst |
Postfächer (wd remote mail)
Nur lesend: wd verschickt und löscht hier nichts.
| Befehl | Bedeutung |
|---|---|
wd remote mail |
deine Postfächer mit Protokoll, Login und Server |
wd remote mail folders <postfach> |
die Ordner eines Postfachs mit der Zahl der Mails. Bei POP3 nur der Posteingang |
wd remote mail messages <postfach> |
die neuesten Mails eines Ordners mit Nummer, Absender, Betreff und Alter. Optionen: --folder (Vorgabe INBOX), -n (Vorgabe 20), --search <text> |
wd remote mail show <postfach> <nummer> |
eine Mail mit Kopfzeilen und Text. 1 ist die neueste. Mit --id gibst du statt der Nummer die ID aus der --json-Ausgabe an, --folder wie oben |
Cronjobs auf Servern (wd remote cron)
| Befehl | Bedeutung |
|---|---|
wd remote cron |
Aufgaben auf deinen Servern mit Server, Zeitplan und nächstem Lauf |
wd remote cron run <aufgabe> |
Aufgabe jetzt auf ihrem Server ausführen und das Ende ihres Logs zeigen. Exit-Code 1, wenn sie fehlschlägt |
wd remote cron add <name> --server <verbindung> --schedule <cron> --command <befehl> |
neue Aufgabe. Statt --command geht --file <skript> für ein Skript auf dem Server |
wd remote cron edit <aufgabe> |
ändern, nur was du angibst: --name, --schedule, --command, --file, --run-by |
wd remote cron delete <aufgabe> |
Aufgabe löschen. Eine Zeile in der Crontab des Servers geht mit. Fragt vorher |
--run-by legt fest, wer die Aufgabe startet: webdonkey (dein Mac über SSH, die Vorgabe) oder server (eine Zeile in der Crontab des Servers). --paused legt sie pausiert an. Gibt es denselben Aufgabennamen auf mehreren Servern, schreibst du name (server).
Backups von Servern (wd remote backup)
| Befehl | Bedeutung |
|---|---|
wd remote backup |
deine Server-Backups mit Server, Zeitplan und letztem Lauf |
wd remote backup run <backup> |
jetzt sichern. Schlägt die Speicherprüfung fehl, bricht es ab, --force sichert trotzdem |
wd remote backup add <name> --server <verbindung> |
neues Server-Backup (Optionen unten) |
wd remote backup edit <backup> |
ändern, nur was du angibst. Eine angegebene Liste ersetzt die alte |
wd remote backup delete <backup> |
löschen. Fragt vorher. Die Archive auf deinem Mac bleiben, außer mit --archives |
| Option | Bedeutung | Vorgabe |
|---|---|---|
--path <pfad> |
Ordner oder Datei auf dem Server, relativ zum Startordner. Mehrfach möglich | |
--db [eintrag:]datenbank |
Datenbank, die gedumpt wird. Den Eintrag darfst du weglassen, wenn der Server nur einen hat. Mehrfach möglich | |
--exclude <muster> |
was nicht mitgesichert wird, relativ zu jedem Pfad, zum Beispiel var/cache |
|
--to <ziel> |
local (dein Mac) oder remote (ein Ordner auf dem Server, mit --dest-path) |
local |
--folder <ordner> |
Ordner auf deinem Mac für --to local |
der Ordner von WebDonkey für diesen Server |
--schedule <plan> |
off, hourly, daily, weekly oder custom |
off |
--at HH:MM |
Uhrzeit für daily und weekly |
03:00 |
--weekday <tag> |
mon bis sun für weekly |
mon |
--cron <ausdruck> |
eigener Cron-Ausdruck, setzt den Plan auf custom |
|
--keep <n> |
wie viele Archive bleiben | 10 |
--name-pattern <muster> |
Dateiname des Archivs ohne Endung, mit {name}, {server}, {date} und {time} |
Free und Premium
Alle Befehle unter wd remote brauchen Premium, wie die Remote-Seiten der App. Im Free-Tarif enden sie mit Exit-Code 4.
Wenn es nicht klappt
| Was du siehst | Warum | Was du tust |
|---|---|---|
wd remote ssh fragt nach einem Passwort |
Die Verbindung meldet sich per Passwort an | Das Passwort eingeben oder auf der Seite SFTP / SSH einen Schlüssel hinterlegen |
Meldung mit remote_conn_has_ beim Löschen |
Aktive Aufgaben, Backups oder Sync-Paare nutzen die Verbindung noch | Diese zuerst löschen oder auf eine andere Verbindung umstellen |
Meldung mit remote_backup_space und dem Hinweis --force |
Die Speicherprüfung vor dem Backup ist fehlgeschlagen, es fehlt Platz | Platz schaffen oder bewusst mit --force wiederholen |
| Mehrdeutiger Aufgabenname | Dieselbe Aufgabe heißt auf mehreren Servern gleich | name (server) angeben |
| Nichts zu ändern | edit ohne Option aufgerufen |
Mindestens eine Option angeben |
Siehe auch
Monitor und SEO Free & Premium
Mit wd monitor steuerst du die Seite Monitor: überwachte Adressen auflisten, sofort prüfen, anlegen, ändern und löschen, den Schalter Automatisch prüfen setzen und Lighthouse-Messungen starten. wd seo gehört zur Seite SEO und startet die Website-Prüfung und den Crawl eines Audits.
So findest du es
Im Terminal: wd monitor --help und wd seo --help.
So gehst du vor
Eine Adresse überwachen und gleich messen:
wd monitor add https://shop.example.com --label Shop --interval 5legt die Adresse an, geprüft wird alle 5 Minuten.wd monitor check Shopprüft sie jetzt und zeigt Status, Antwortzeit und Ablauf des Zertifikats.wd monitor lighthouse Shop --profile mobilemisst die Seite mit Lighthouse und gibt die Werte aus.
Monitor (wd monitor)
| Befehl | Bedeutung |
|---|---|
wd monitor |
überwachte Adressen mit Projekt, URL, Status, Antwortzeit, Ablauf des Zertifikats und letzter Prüfung. Dasselbe wie wd monitor list |
wd monitor check [adresse] |
eine Adresse jetzt prüfen. Ohne Namen: alle |
wd monitor add <url> |
eine Adresse überwachen (Optionen unten) |
wd monitor edit <adresse> |
eine Adresse ändern, nur was du angibst |
wd monitor delete <adresse> |
die Überwachung beenden und den Verlauf löschen. Fragt vorher |
wd monitor auto [on|off] |
den Schalter Automatisch prüfen für alle Projekte und Adressen setzen. Ohne Wert: den Zustand zeigen |
wd monitor lighthouse [adresse] |
eine Lighthouse-Messung starten, warten und die Werte für Leistung, Barrierefreiheit, Best Practices und SEO ausgeben |
| Option | Bedeutung | Vorgabe |
|---|---|---|
--label <name> |
Name in der Liste | der Hostname der Adresse, etwa shop.example.com |
--project <projekt> |
Projekt, in dem die Adresse steht. Bei edit: in ein anderes Projekt verschieben |
das erste Projekt. Gibt es noch keins, legt wd eins an |
--interval <minuten> |
Abstand zwischen zwei Prüfungen | 15 |
--keyword <text> |
Text, den die Seite enthalten muss. Bei edit entfernt "" ihn |
keiner |
--url <url> |
neue Adresse (nur edit) |
|
--profile <profil> |
mobile, desktop oder both (nur lighthouse) |
both |
--detach |
Lighthouse starten und sofort zurückkehren (nur lighthouse) |
aus |
Eine neue Adresse folgt dem Schalter ihres Projekts: Ist Automatisch prüfen dort aus, ist es auch bei ihr aus.
SEO (wd seo)
| Befehl | Bedeutung |
|---|---|
wd seo |
deine SEO-Audits mit Adresse und letzter Prüfung. Dasselbe wie wd seo list |
wd seo check [audit] |
die Website-Prüfung des Audits jetzt ausführen und jedes Ergebnis ausgeben: bestanden, Warnung, Fehler oder Hinweis, mit Code, Gruppe und Wert |
wd seo crawl [audit] |
den Crawl des Audits starten, wie Audit starten auf der Seite SEO. wd wartet und zeigt den Fortschritt. Mit --detach kehrt es sofort zurück |
Am Ende von wd seo crawl stehen die Zahl der gecrawlten Seiten und der Funde. Die Auswertung siehst du in der App auf der Seite SEO.
Audits legst du in der App an, nicht mit wd.
Free und Premium
- Monitor: im Free-Tarif ein Projekt mit bis zu drei Adressen, mit allen Funktionen einschließlich Lighthouse. Premium hebt die Grenze auf.
wd monitor addendet an der Grenze mit Exit-Code 4. - SEO: braucht das SEO-Paket. Ohne endet
wd seo checkundwd seo crawlmit Exit-Code 4 und der Meldung, dass ein WebDonkey-Zusatzpaket benötigt wird.
Wenn es nicht klappt
| Was du siehst | Warum | Was du tust |
|---|---|---|
| Kein Ergebnis, die App zeige den Grund | Lighthouse konnte die Seite nicht messen | Die Meldung auf der Seite Monitor in der App lesen |
Exit-Code 4 bei wd monitor add |
Die Free-Grenze ist erreicht | Eine Adresse löschen oder Premium aktivieren |
Exit-Code 4 bei wd seo |
Das SEO-Paket fehlt | Siehe SEO-Paket |
| Mehrdeutiger Name | Mehrere Adressen passen auf die Abkürzung | Den Namen aus wd monitor vollständiger angeben |
Siehe auch
Weitere Werkzeuge Free & Premium
Diese Befehle gehören zu den Seiten in der Gruppe Werkzeuge und zu den Einstellungen: Workflows ausführen, Notizen lesen und schreiben, virtuelle Maschinen steuern, KI-Chats und CLI-Konfigurationen verwalten, MCP-Server schalten, Abonnements pflegen, Themes wechseln, Einstellungen setzen und den Zustand von Claude Code abfragen.
So findest du es
Im Terminal: wd workflows --help, wd notes --help, wd vms --help, wd ai --help, wd mcp --help, wd subscriptions --help, wd themes --help, wd settings --help, wd claude --help.
So gehst du vor
Einen Workflow aus einem Git-Hook oder Skript starten und das Ergebnis auswerten:
wd workflowszeigt deine Workflows mit Status, letztem und nächstem Lauf.wd workflows run deploy --data '{"branch":"main"}'startet ihn über seinen Start von Hand und übergibt die Eingabefelder.wdwartet, zeigt jeden Schritt und endet mit Exit-Code 1, wenn der Lauf fehlschlägt.
Workflows (wd workflows)
Workflows sind eine Beta-Funktion. Andere Schreibweisen: wd workflow, wd wf.
| Befehl | Bedeutung |
|---|---|
wd workflows |
Workflows mit an oder aus, letztem Lauf und nächstem geplanten Lauf. Ein Hinweis nennt Workflows über der Free-Grenze oder mit Premium-Knoten |
wd workflows run <workflow> |
den Workflow ausführen, über seinen Start von Hand (sonst den ersten Auslöser), warten und seine Schritte zeigen. Exit-Code 1, wenn der Lauf fehlschlägt |
wd workflows runs <workflow> |
die letzten Läufe mit Status, Start, Dauer, Auslöser und Fehler. -n legt die Zahl fest (Vorgabe 10) |
wd workflows enable <workflow> |
einschalten, seine Auslöser starten ihn wieder |
wd workflows disable <workflow> |
ausschalten |
run kennt --data '<json>' für die Eingabefelder des Starts von Hand, zum Beispiel '{"name":"x"}', und --detach, um sofort mit der Lauf-ID zurückzukehren. Workflows anlegen und bearbeiten geht nur in der App.
Notizen (wd notes)
Die Befehle arbeiten im aktiven Vault der Seite Notizen. Andere Schreibweise: wd note.
| Befehl | Bedeutung |
|---|---|
wd notes |
alle Notizen des aktiven Vaults mit ihrem Pfad |
wd notes show <notiz> |
eine Notiz ausgeben |
wd notes new <pfad> [text] |
eine Notiz anlegen, .md hängt wd selbst an, zum Beispiel wd notes new projekte/shop "Erste Zeile" |
wd notes append <notiz> [text] |
eine Zeile ans Ende einer Notiz anhängen |
Fehlt der Text als Argument, liest wd ihn aus einer Pipe, etwa echo "- Kontaktformular prüfen" | wd notes append projekte/shop.
Virtuelle Maschinen (wd vms)
Virtuelle Maschinen sind eine Beta-Funktion. Andere Schreibweise: wd vm.
| Befehl | Bedeutung |
|---|---|
wd vms |
virtuelle Maschinen mit System, CPUs, Arbeitsspeicher, Festplatte und SSH-Port, laufende mit grünem Punkt |
wd vms start <vm>, wd vms stop <vm> |
eine VM starten oder stoppen |
wd vms create <name> |
eine VM anlegen, die Festplatte entsteht sofort |
wd vms edit <vm> |
Name, Abbild, System, Architektur, CPUs, Arbeitsspeicher oder SSH-Port ändern, nur bei gestoppter VM |
wd vms delete <vm> |
eine gestoppte VM samt Festplatte löschen. Fragt vorher |
| Option | Bedeutung | Vorgabe |
|---|---|---|
--iso <datei> |
Installationsabbild (.iso) auf deinem Mac. Bei edit wirft "" es aus |
keins |
--os <system> |
linux, windows oder bsd |
linux |
--arch <arch> |
aarch64 oder x86_64 |
die deines Macs |
--cpus <n> |
Zahl der CPUs | 2 |
--ram <gb> |
Arbeitsspeicher in GB | 4 |
--disk <gb> |
Größe der Festplatte in GB, nach dem Anlegen fest (nur create) |
32 |
--ssh-port <port> |
Port auf deinem Mac für SSH in die VM, 0 heißt keiner |
0 |
KI (wd ai)
| Befehl | Bedeutung |
|---|---|
wd ai |
deine KI-Chats mit Modell und letzter Änderung. Dasselbe wie wd ai chats |
wd ai rename <chat> <neuer titel> |
einen Chat umbenennen, zum Beispiel wd ai rename "Neuer Chat" Shop Checkout |
wd ai configs |
die Chat-Konfigurationen (Modell, Speicher, Spezialist) und die CLI-Konfigurationen (CLI, Modell, Speicher, Ordner) |
wd ai cli-add <name> --model <modell> |
eine CLI-Konfiguration für den Reiter CLI der Seite KI anlegen |
wd ai cli-delete <konfiguration> |
eine CLI-Konfiguration löschen. Fragt vorher, laufende Terminals laufen weiter |
wd ai models |
die installierten Modelle des lokalen Ollama mit Größe und deinen Notizen. Läuft Ollama nicht, sagt wd es |
cli-add kennt --cli (aider als Vorgabe, qwen-code, codex-cli, goose, opencode, crush), --model (ein Modell aus wd ai models, Pflicht), --memory (Speicher für Modell und Kontext in GB, mindestens 1, oder auto als Vorgabe) und --folder (Arbeitsordner, Vorgabe der aktuelle). Chatten mit einem Modell geht nur in der App.
MCP (wd mcp)
| Befehl | Bedeutung |
|---|---|
wd mcp |
die eingerichteten MCP-Server deiner KI-Clients mit Client, Bereich, Verbindungsart und Zustand, laufende mit grünem Punkt |
wd mcp clients |
die KI-Clients, die WebDonkey kennt, ob sie auf diesem Mac sind und wie viele Server sie haben |
wd mcp enable <server>, wd mcp disable <server> |
einen Server ein- oder ausschalten. Der Eintrag bleibt. wd sagt, ob es nach einem Neustart des Clients oder in einer neuen Sitzung wirkt |
Gibt es einen Server bei mehreren Clients, nennst du ihn als name · client, zum Beispiel "github · Claude Code". Server hinzufügen und bearbeiten geht nur in der App. Manche Einträge verwaltet ihr Client selbst, die lassen sich hier nicht schalten.
Abonnements (wd subscriptions)
| Befehl | Bedeutung |
|---|---|
wd subscriptions |
deine Abonnements mit Betrag je Zeitraum, nächster Abbuchung und Kündigungsfrist, darunter die Summen je Monat und Jahr |
wd subscriptions add <name> --price <betrag> |
ein Abonnement hinzufügen |
wd subscriptions delete <abo> |
ein Abonnement löschen. Fragt vorher |
Option von add |
Bedeutung | Vorgabe |
|---|---|---|
--price <betrag> |
Betrag je Zeitraum, zum Beispiel 9.99 oder 9,99 |
Pflicht |
--currency <code> |
Währungscode | EUR |
--every <zeitraum> |
day, week, month, quarter oder year |
month |
--start <datum> |
erste Abbuchung als JJJJ-MM-TT, die nächsten folgen daraus |
heute |
--url <adresse> |
Website des Dienstes | |
--notice-days <tage> |
Kündigungsfrist in Tagen, daraus entsteht das Datum „kündigen bis“ |
Themes und Einstellungen (wd themes, wd settings)
| Befehl | Bedeutung |
|---|---|
wd themes |
eingebaute Themes (System, Arctic, Aurora), Vorlagen und deine eigenen. Das aktive ist markiert |
wd themes use <theme> |
ein Theme tragen: system, arctic, aurora, eine Vorlage oder eins deiner eigenen über seinen Namen |
wd settings |
die Haupteinstellungen mit ihren Werten |
wd settings get <schlüssel> |
den Wert einer Einstellung |
wd settings set <schlüssel> <wert> |
eine Einstellung ändern, zum Beispiel wd settings set language en |
| Schlüssel | Erlaubte Werte |
|---|---|
language |
cs, da, de, en, es, fr, fr-BE, it, ja, ko, nl, nl-BE, pl, ru, uk, zh |
default_editor |
webdonkey-editor, vscode, cursor, phpstorm, webstorm, zed, sublime, nova, system |
default_sites_root |
ein absoluter Ordnerpfad |
terminal_open |
auto, editor, webdonkey, system |
folder_open |
auto, editor, code, finder |
code_open |
auto, editor, code |
db_open |
auto, editor, webdonkey |
remote_notices |
on, off |
theme |
wie bei wd themes use |
Statt _ darfst du - schreiben, default-editor ist also dasselbe wie default_editor. Ein Wert, den die Einstellung nicht kennt, endet mit einer Meldung, die die erlaubten Werte nennt.
Claude Code (wd claude)
| Befehl | Bedeutung |
|---|---|
wd claude |
ob Claude Code installiert ist, mit welchem Konto du angemeldet bist, die Live-Limits deines Plans und die laufenden Instanzen. Dasselbe wie wd claude status |
wd claude sessions |
die laufenden Claude-Instanzen mit PID, Name, Art, Status, Ordner, Modell und Auslastung des Kontexts |
wd claude usage |
Tokens je Tag, geschätzt aus den lokalen Transkripten, mit dem ungefähren API-Gegenwert. --days <n> legt den Zeitraum fest (Vorgabe 30, heute eingeschlossen) |
Die Live-Limits erscheinen erst, wenn du auf der Seite Claude die Statusline-Brücke eingebaut hast (Live-Limits anzeigen (Statusline-Brücke einbauen)). Keiner dieser Befehle verbraucht Tokens.
Free und Premium
| Befehle | Free | Premium |
|---|---|---|
wd workflows |
3 Workflows aus den freien Knoten | alle Workflows und Knoten |
wd notes |
nein | ja |
wd vms |
ja | ja |
wd ai |
alles außer cli-add |
alles |
wd mcp |
Liste und Clients | dazu enable und disable |
wd subscriptions |
6 Abonnements | beliebig viele |
wd themes use |
System, Arctic und Aurora | dazu die Vorlagen und deine eigenen Themes |
wd settings |
ja | ja |
wd claude |
Status und Sitzungen | dazu usage |
Wird eine Grenze erreicht oder fehlt Premium, endet der Befehl mit Exit-Code 4.
Wenn es nicht klappt
| Was du siehst | Warum | Was du tust |
|---|---|---|
wd workflows run meldet einen Fehler zu --data |
Der Text ist kein gültiges JSON | Das JSON in einfache Anführungszeichen setzen: --data '{"name":"x"}' |
| Nichts anzufügen | wd notes append ohne Text und ohne Pipe |
Text angeben oder per Pipe übergeben |
| Ollama läuft nicht | Der Dienst Ollama ist aus | wd services start ollama |
| Meldung, ein MCP-Server lasse sich hier nicht schalten | Sein Client verwaltet den Eintrag selbst | Den Server im Client oder auf der Seite MCP ändern |
Meldung unknown setting |
Der Schlüssel ist keiner der Haupteinstellungen | wd settings zeigt die bekannten Schlüssel |
Siehe auch
Optionen und Exit-Codes Free
Einige Optionen gelten für jeden Befehl von wd, egal ob du sie vor oder nach dem Befehl schreibst. Dazu kommen die Exit-Codes, an denen Skripte erkennen, wie ein Befehl ausgegangen ist, und das JSON-Format für Fehler.
So findest du es
Im Terminal: wd --help zeigt die Optionen und die Exit-Codes am Ende der Hilfe. wd <befehl> --help zeigt die Optionen eines Befehls.
So gehst du vor
wd in einem Skript sicher verwenden:
- Gib
--jsonmit, wenn du die Ausgabe auswertest. Die Textausgabe ist für Menschen und darf sich ändern. - Gib
-ymit, wenn der Befehl nachfragen würde, zum Beispiel beim Löschen. - Gib
--no-launchmit, wenn die App nicht von selbst starten soll. - Entscheide nach dem Exit-Code und lies dann die Meldung.
if ! out=$(wd sites start shop --json -y --no-launch); then
echo "$out" | jq -r '.error.message'
fi
Optionen für jeden Befehl
| Option | Bedeutung |
|---|---|
--json |
genau ein JSON-Dokument auf stdout: das Ergebnis oder der Fehler. Rückfragen gehen auf stderr, stdout bleibt dem JSON vorbehalten. Einzige Ausnahme: wd logs tail -f --json gibt je Zeile ein Objekt { "line": "…" } aus |
-y, --yes |
Rückfragen mit Ja beantworten: App starten, Port freiräumen, Site löschen, Datenbank löschen, WebDonkey entfernen |
--no-launch |
die App nie automatisch starten. Ist sie zu, endet der Befehl mit Exit-Code 3 |
--no-color |
ohne Farben. Greift auch, wenn NO_COLOR gesetzt ist oder die Ausgabe in keine Konsole geht |
-h, --help |
Hilfe zum Befehl |
-V, --version |
Version der App, zu der dieses wd gehört |
Einzelne Befehle haben eigene Optionen, etwa -n und -f bei wd logs tail. Sie stehen auf den Seiten der Befehle.
Exit-Codes
| Code | Bedeutung |
|---|---|
0 |
Erfolg |
1 |
Der Befehl lief und ist fehlgeschlagen, zum Beispiel ein Dienst ließ sich nicht starten oder eine Aufgabe endete mit Fehler. Auch: Die laufende App ist älter als wd |
2 |
Falsche Verwendung: Tippfehler, fehlendes Argument, mehrdeutiger Name ohne Terminal oder fehlendes -y bei einer Rückfrage |
3 |
Die App ist nicht erreichbar: Sie läuft nicht und wurde nicht gestartet, wegen --no-launch oder weil ohne Terminal niemand die Rückfrage beantworten kann |
4 |
Die Funktion braucht WebDonkey Premium oder ein Zusatzpaket, oder eine Free-Grenze ist erreicht |
Einige Befehle melden ihr Ergebnis auch bei einem Fehlschlag vollständig, etwa wd cron run mit Exit-Code und Ausgabe der Aufgabe. Der Exit-Code ist dann trotzdem 1.
Fehler als JSON
Mit --json sieht ein Fehler so aus:
{ "ok": false, "error": { "kind": "failed", "code": 1, "message": "…" } }
kind |
Exit-Code | Bedeutung |
|---|---|---|
failed |
1 | der Befehl ist fehlgeschlagen |
app_outdated |
1 | die App ist älter als wd, ein Update der App hilft |
usage |
2 | falsche Verwendung, message nennt bei mehrdeutigen Namen die Kandidaten |
unreachable |
3 | die App läuft nicht |
premium |
4 | Premium, Zusatzpaket oder Free-Grenze. detail nennt die Grenze, etwa premium_service_limit:6/6 |
Zwei Zusatzfelder helfen beim Beheben: hint nennt einen Befehl, etwa wd free-port 3306 bei einem belegten Port oder --no-ssl an der HTTPS-Grenze. detail steht bei premium und app_outdated.
Rückfragen, Auswahl und Namen
- Namen abkürzen: Fast überall darfst du Namen abkürzen. Passt genau einer, nimmt
wdihn. Passen mehrere, öffnet sich im Terminal eine Auswahl. Ohne Terminal endet der Befehl mit Exit-Code 2 und listet die Kandidaten. - Name weglassen: Im Terminal öffnet sich die Auswahl. In einem Skript gibst du den Namen immer an.
- Kein Treffer:
wdmeldet es und schlägt, wenn möglich, einen ähnlichen Namen vor („meintest du …?“). - Rückfragen vor endgültigen Aktionen beantwortest du im Terminal mit Ja oder Nein. Ohne Terminal und ohne
-ybrichtwdmit Exit-Code 2 ab, statt still zu bestätigen oder zu hängen.
Was im Hintergrund passiert
wd spricht über eine Unix-Socket-Datei im Ordner von WebDonkey mit der App: ~/Library/Application Support/WebDonkey/runtime/control.sock, nur für deinen Benutzer lesbar. Es gibt keinen Netzwerkport und kein Token. Was du mit wd tust, tust du mit deinen Rechten.
Normale Befehle warten bis zu 10 Minuten auf eine Antwort der App. Befehle, die lange dauern können, etwa Backups, Installationen, geplante Aufgaben oder das Hochladen über SFTP, warten bis zu 6 Stunden.
Wenn es nicht klappt
| Was du siehst | Warum | Was du tust |
|---|---|---|
| WebDonkey läuft nicht und Exit-Code 3 | Die App ist zu und wd durfte sie nicht starten |
wd app start oder den Befehl mit -y wiederholen |
| Die laufende WebDonkey-App ist für diesen Befehl zu alt | wd ist neuer als die laufende App, etwa direkt nach einem Update |
Die App neu starten oder aktualisieren |
Exit-Code 2 mit dem Hinweis, mit -y zu bestätigen |
Der Befehl will nachfragen, aber es gibt kein Terminal | -y mitgeben, wenn du die Aktion wirklich willst |
wd logs tail -f kehrt nie zurück |
-f verfolgt die Datei, bis du abbrichst |
In Skripten -n mit fester Zeilenzahl verwenden |
Siehe auch
Briefing für KI-Agenten Free
Arbeitest du mit Claude Code, Cursor, Codex oder einem anderen KI-Agenten, kann der WebDonkey selbst bedienen: Dienste starten, Sites anlegen, Logs lesen, Portkonflikte erkennen, Datenbanken sichern. Er muss nur wissen, wie. Der Block unten ist genau dieses Wissen: alle Befehle, die JSON-Formate mit Beispielen, die Exit-Codes und, genauso wichtig, was wd nicht kann. Ohne diesen letzten Teil erfinden Agenten Befehle, die es nicht gibt.
So findest du es
Seitenleiste Werkzeuge › Terminal, Karte WebDonkey CLI, Knopf Anleitung für KI-Agenten. Er öffnet diese Seite in der Doku der App. Das Briefing steht weiter unten auf dieser Seite als Block.
So gehst du vor
- Kopiere den Block unten. In der App geht das mit dem Knopf Code kopieren oben rechts im Block.
- Leg ihn in die Kontextdatei deines Agenten:
CLAUDE.md,AGENTS.md,.cursorrulesoder den Systemprompt. - Ab dann weiß der Agent, wie er mit deiner Umgebung umgeht. Frag ihn zum Beispiel: „Warum lädt shop.test nicht?“
Der Text ist bewusst auf Englisch, auch wenn die App auf Deutsch läuft. Er wird nicht von dir gelesen, sondern vom Modell, und Coding-Agenten folgen englischen Anweisungen zuverlässiger.
Für Claude Code: den Agenten aktuell halten
Mit Claude Code geht es ohne Kopieren und bleibt bei jedem Update aktuell:
- Öffne die Seite Werkzeuge › Claude, Reiter Hooks.
- Schalte WebDonkey-Agent aktuell halten ein.
Beim Start jeder neuen Claude-Sitzung schreibt WebDonkey dann den Agenten webdonkey-cli nach ~/.claude/agents/webdonkey-cli.md, mit diesem Briefing und allen Befehlen der installierten Version samt ihren Optionen. Neue Befehle kommen so mit jedem Update dazu. Der Hook gibt nichts in die Sitzung aus, Claude liest den ganzen Agenten erst, wenn es ihm eine Aufgabe gibt.
Was im Hintergrund passiert
- Der Schalter legt in deinen Claude-Einstellungen einen Hook für den Sitzungsstart an, der
wd claude refresh-agentaufruft. Schaltest du ihn aus, entfernt WebDonkey den Hook wieder. - Ist
CLAUDE_CONFIG_DIRgesetzt, landet der Agent im Ordneragentsdort statt in~/.claude/agents. - Die Datei trägt eine Markierungszeile von WebDonkey. Nur eine Datei mit dieser Zeile wird überschrieben. Löschst du die Zeile, bleibt deine eigene Fassung erhalten. Eine eigene
webdonkey-cli.mdohne die Zeile fasst WebDonkey nie an. - Ist der Text schon aktuell, schreibt WebDonkey die Datei nicht neu.
Was ausdrücklich drinsteht
- Ein abgestürzter Dienst gilt nicht als gesund:
statushat sechs Werte, nicht zwei. - Vor Aktionen, die laufende Arbeit oder Daten betreffen, fragt der Agent nach, etwa vor
wd free-port,wd db dropoderwd sites delete. wd uninstallist nie eine Reparatur.- Passwörter gehen nur über
--password-stdin, nie als Argument und nie über den Chat. - Was nur in der App geht, etwa Workflows bearbeiten oder mit einem KI-Modell chatten.
Free und Premium
Das Briefing ist kostenlos. Der Schalter WebDonkey-Agent aktuell halten auf der Seite Claude braucht Premium.
Der Block
# WebDonkey, briefing for AI agents
## Purpose
WebDonkey is a local web development environment for macOS. It runs services
(PHP-FPM, MySQL, MariaDB, PostgreSQL, Redis, nginx, Apache, Caddy, Node,
Mailpit, …), serves local sites on real domains with HTTPS through a front
proxy on ports 80/443, and runs scheduled tasks and project backups. It also
manages remote servers (tasks, backups), monitored
addresses, workflows, notes and virtual machines.
You control it with the `wd` command. `wd` manages nothing itself: it talks
to the running WebDonkey app over a local socket and calls the same functions
as the app's UI. Whatever you change is immediately visible in the app, and
the other way round.
## Rules
1. **Check first, then act.** Read the state (`wd status --json`) before you
start, stop or switch anything.
2. **Always pass `--json` when you read output.** The text output is for
people and may change; the JSON shapes below are stable. Fields may be
added, existing ones do not disappear.
3. **Pass `-y` on commands that would ask.** Without a terminal there is no
one to answer a question, so `wd` refuses instead of guessing (exit 2),
or does not launch the app (exit 3).
4. **Decide by exit code, then read the message.** 0 is success; everything
else carries a JSON error (see *Errors*).
5. **Only use the commands listed here.** If something is not listed, it does
not exist, say so instead of inventing it. `wd --help` and
`wd <command> --help` show the real list.
6. **Ask before destructive actions**: `wd free-port`, `wd services stop --all`,
`wd sites stop`, `wd sites delete`, `wd db drop`, `wd db restore`,
`wd remote delete`, `wd vms stop`, `wd vms delete`, `wd monitor delete`,
`wd proxy stop`, `wd app stop`. They
affect the user's running work or data. **Never run `wd uninstall`** unless the
user explicitly asks to remove WebDonkey from the Mac, it is not a fix
for anything. The same goes for `wd db users delete|revoke|password`,
`wd logs custom clear`, `wd subscriptions delete`, `wd mcp disable`,
`wd sites create --package` and `wd settings set`: only when the user asks.
7. **When something does not work, start with `wd doctor --json`.** It checks
PATH, app, versions, crashed services, sites and the front proxy, and names
the fix for every problem it finds.
## Is WebDonkey available?
```bash
command -v wd # is the CLI installed?
wd app status --json # is the app running?
```
```json
{ "running": true, "app_version": "<version>" }
```
- `command -v wd` prints nothing → WebDonkey is not installed, or its
terminal integration ("Tools in the terminal" in the app's settings) is
off. Tell the user; do not try to install anything yourself.
- `wd app status` exits with 3 and prints `{ "running": false }` → the app
is closed. Start it with `wd app start --json` (it waits until the app
answers), then continue.
## Options on every command
| Option | Effect |
|---|---|
| `--json` | exactly one JSON document on stdout: the result, or the error |
| `-y`, `--yes` | answer confirmations with yes: starting the app, freeing a port, deleting a site, uninstalling |
| `--no-launch` | never start the app; exit 3 when it is closed |
| `--no-color` | no colours (also honours `NO_COLOR` and non-terminals) |
| `-h`, `--help` | help for the command, e.g. `wd sites create --help` |
| `-V`, `--version` | version of the app this `wd` belongs to |
## Commands
Names may be abbreviated (`my` finds `mysql`). Without a terminal, an
ambiguous name is an error that lists the candidates, use a more specific
name then. Leaving a name out opens a picker in a terminal; you have none, so
always name the service, site, log, task or connection.
Aliases that work too: `wd ls` and `wd service` (= `wd services`), `wd site`,
`wd databases` (= `wd db`), `wd tasks` (= `wd cron`), `wd backups`,
`wd servers` (= `wd remote`), `wd certs` (= `wd ssl`),
`wd wf` (= `wd workflows`), `wd note`, `wd vm`, `wd mails`.
### Overview
```bash
wd status --json
```
```json
{
"app_version": "<version>",
"premium": false,
"proxy": { "running": true, "last_error": null },
"services_total": 3,
"services_running": [{ "package_id": "mysql", "version": "<version>" }],
"sites": [{ "domain": "shop.test", "ssl": true, "webserver": "nginx" }]
}
```
### Services
```bash
wd services --json # installed services, running first
wd services start mysql redis --json # start one or more
wd services start php@<version> --json # a specific installed version
wd services stop mysql --json
wd services restart php --json
wd services stop --all --json # everything, ask first
wd services install redis --json # newest stable version
wd services install php@<version> --json
wd services use php@<version> --json # the version new shells and plain starts use
wd services use php --json # without a version: show the active and the installed ones
```
`wd services --json` returns a list:
```json
[{ "package_id": "mysql", "name": "MySQL", "version": "<version>",
"status": "Running", "uptime_seconds": 5400, "installed": true }]
```
`status` is one of `Running`, `Starting`, `Stopping`, `Stopped`,
`Crashed`, `Unknown`. Treat a service as usable only when it is
`Running`, never test for `!= "Stopped"`, a crashed service would pass.
start/stop/restart return the state afterwards:
```json
{ "ok": true, "action": "start",
"services": [{ "package_id": "mysql", "version": "<version>", "status": "Running", "...": "…" }] }
```
`wd services install` returns `{ "ok": true, "action": "install", "installed":
[{ "package_id", "version" }] }` and can take minutes (downloads).
`wd services use php --json` (no version) returns
`{ "package_id": "php", "active": "<version>", "installed": ["<version>", "…"] }`;
`active` is null when the newest installed version is used. With a version it
switches: new terminal windows use it at once, running services keep theirs
until they are restarted. A version that is not installed is an error that
lists the installed ones.
`wd start`, `wd stop`, `wd restart` and `wd ls` are short forms of the same
commands. `wd services start php` starts the version marked active in the
app; name a version only when the project needs a different one.
### Sites
```bash
wd sites --json # every site
wd sites start shop --json # switch on + start what it needs (PHP, webserver, databases)
wd sites stop shop --json # switch off: the domain is released, ask first
wd sites open shop # open in the user's browser
wd sites create shop.test --path /abs/project --php <version> --json
# new site for a folder, started right away; HTTPS unless --no-ssl
wd sites create shop.test --name "Shop" --webserver caddy --no-ssl --json
# display name, nginx (default) | caddy | apache, plain HTTP
wd sites delete shop -y --json
# configuration, certificate, logs, the folder stays; ask first
wd sites info shop --json # one site with every field
wd sites php shop <version> --json
# pin the site to an installed PHP version (Node: wd sites node)
wd sites diagnose shop --json # the Sites page's checks; exit 1 if one fails
wd sites packages --json # site packages: id, name, description, requires
wd sites packages wordpress --json
# one package with its settings (key, default, options)
wd sites create blog.test --path /abs/blog --package wordpress --set site_title=Blog --json
# site + package install (Premium); waits, { "ok", "site", "steps" }
```
`wd sites create` without options: the current folder, the domain as name,
nginx, no PHP (a static site), HTTPS. `--path` may start with `~/`. It
starts what the site needs, like `wd sites start`; when that fails, the site
is still created but switched off, `started` is `false` and
`site.start_error` says why. Results: start/stop
`{ "ok": true, "action": "start", "site": { … } }`, create
`{ "ok": true, "action": "create", "started": true, "site": { … } }`, delete
`{ "ok": true, "action": "delete", "id": "…", "domain": "shop.test" }`.
Each site in `wd sites --json`: `id`, `name`, `domain`, `aliases`,
`path`, `webserver`, `php_version`, `node_version`, `ssl_enabled`,
`enabled`, `serve_command`, `serve_port`, `env`, … . `enabled: false`
means the site exists but is switched off and will not answer, a common
reason for "my site does not load". `wd sites start <site>` fixes exactly
that. `wd sites diagnose` returns `{ "ok", "domain", "items": [{ "label",
"ok", "detail" }] }`; a version that is not installed is an error naming
`wd services install php@<version>`.
`--package` works like the Sites form: every setting at the package's
default (the database name from the domain), `--set KEY=VALUE` over it, the
newest installed PHP/Node the package accepts unless `--php` names one. It
stops before creating anything with `site_package_requirements: …` (install
what it names), `site_package_db_not_empty: …` (another `--set db_name=…`) or
`site_package_files: …` (files it would replace, ask the user, then repeat
with `--overwrite`). A failed install exits 1 with its `steps`; the site stays.
### Certificates
```bash
wd ssl --json # { "ca_trusted", "certificates": [{ "site_domain", "days_left", "not_after", "sans", … }] }
wd ssl renew shop --json # issue the site's certificate again
wd ssl trust # trust the local CA, macOS asks the user for a password; only on request
```
### Databases
```bash
wd db --json
```
```json
[{ "kind": "mysql", "display": "MySQL", "version": "<version>", "port": 3306,
"running": true, "databases": ["shop"], "users": ["root"] }]
```
Databases are listed only while their server runs.
```bash
wd db shell mysql shop -- -e "SHOW TABLES" # run SQL, logged in as root
wd db shell postgres appdb -- -c "SELECT 1"
```
`wd db shell` starts the engine's own client (mysql, psql, mongosh) already
logged in; everything after `--` goes to that client, so a query runs and
returns. Without client flags it opens an interactive session, not useful to
you. Its output is the client's own text, not JSON.
```bash
wd db create mysql shop --json # new database on a running server
wd db rename mysql shop shop_old --json
wd db drop mysql shop_old -y --json # deletes all its data, ask first
wd db backup mysql shop --json # { "ok", "path", "size_bytes", "note" }
wd db backup postgres app --format pg_custom --folder /abs/dir --json
wd db restore mysql shop /abs/dump.sql.gz -y --json
# the current content is backed up first, ask first
```
`wd db backup` uses the format, file name and folder last chosen in the app
(`--format`: `sql` = gzip-compressed SQL, `sql_plain`, `pg_custom`, `csv`).
A restore that needs an answer fails with `remote_db_restore_version_jump…`
(dump from another major version) or `remote_db_restore_definer…`: ask the
user, then repeat with `--accept-version-jump` or `--rewrite-definers`.
Database users and their rights:
```bash
wd db users --json # per running server: { "kind", "users": [{ "name", "hosts", "system", "global_level", "sites" }], "grants": [{ "user", "database", "level" }] }
wd db users list mysql --json
printf '%s' "$PW" | wd db users add mysql shop_user --database shop --password-stdin --json
wd db users grant mysql shop_user shop --level readonly --json # all | readwrite | readonly
wd db users revoke mysql shop_user shop -y --json
printf '%s' "$PW" | wd db users password mysql shop_user --password-stdin --json
wd db users delete mysql shop_user -y --json
```
A password only ever comes from stdin. The engine's own accounts (root,
postgres …) are refused with `db_system_account: …`, the app logs in with them.
### Logs
```bash
wd logs --json # [{ "id", "label", "path" }]
wd logs tail nginx -n 100 --json # { "id", "label", "path", "lines": [...] }
wd logs nginx -n 100 --json # the same, short form
```
Without `-n` you get the last 100 lines.
`wd logs tail <name> -f` follows the file and never returns (with `--json`
it prints one `{ "line": "…" }` per line). Avoid it in an agent context;
read a fixed number of lines with `-n` instead.
The user's own log files (Logs page, Premium except the list):
```bash
wd logs custom --json # [{ "id", "name", "path" }]
wd logs custom tail app -n 100 --json # { "id", "name", "path", "lines": [...] }
wd logs custom add app /abs/storage/logs/laravel.log --json
wd logs custom clear app -y --json # empties the file, ask first
wd logs custom remove app --json # off the list; the file stays
```
### Scheduled tasks
```bash
wd cron --json # tasks: name, cron_expr, enabled, last_run_at, last_exit_code, next_due_at
wd cron run cleanup --json # run now; waits until it is done
wd cron disable cleanup --json # pause it; wd cron enable switches it on again
wd cron add cleanup --schedule "0 3 * * *" --command "php bin/console app:cleanup" --dir . --json
# --dir: the folder it runs in (relative = from here; default: home); --paused
wd cron edit cleanup --schedule "30 3 * * *" --json
# only what is given changes: --name, --schedule, --command, --dir ("" = home)
wd cron delete cleanup -y --json # ask first
```
```json
{ "ok": true, "id": "…", "name": "cleanup", "exit_code": 0, "output": "…" }
```
If the task's command fails, `ok` is false and `wd` exits with 1, the
result still carries `exit_code` and `output`.
`add` and `edit` save like the page's form and answer
`{ "ok": true, "action": "add", "task": { … } }` with the saved task. The
Free plan's task limit answers with exit 4, and a task over the limit after
Premium ended only takes a new name. `edit` keeps the task on or paused.
### Project backups (Premium)
```bash
wd backup --json # backup sets
wd backup run nightly --json # run now; can take minutes
wd backup runs nightly --json # its archives: archive_path, size_bytes, status, created_at
wd backup add nightly --path . --db shop --schedule daily --at 02:30 --json
# --path, --db [server:]database (server mysql|mariadb|postgres) and
# --exclude (node_modules, var/cache) repeat; --folder /abs/dir or
# --default-folder, --weekday mon…sun, --cron EXPR, --keep N (1 = newest only)
wd backup edit nightly --keep 14 --json
# only what is given changes; a list given (--path, --db, --exclude) replaces
# the old one, '' alone empties it
wd backup delete nightly -y --json
# its archives stay unless --archives, ask first
```
```json
{ "ok": true, "name": "nightly", "status": "ok", "archive_path": "…", "size_bytes": 123456 }
```
`status` is `ok`, `partial` or `failed`; anything but `ok` exits with 1.
On the Free plan both commands exit with 4.
`add` and `edit` save like the page's form (Premium) and answer
`{ "ok": true, "action": "add", "set": { … } }`; without options a new set
backs up nothing, runs only by hand and keeps 10 backups. `delete` works on
the Free plan too, for sets left over from Premium.
### Remote servers (Premium)
```bash
wd remote --json # saved connections: name, host, port, username, auth_kind
wd remote ssh prod -- uptime # run a command on the server
```
Key-based connections run non-interactively. With password login, ssh asks for
the password, you cannot answer that; tell the user instead.
```bash
wd remote test prod --json # { "ok", "home" }, one login
wd remote add prod --host example.com --user deploy --key ~/.ssh/id_ed25519 --json
wd remote delete prod -y --json # refused while tasks or backups use it, ask first
wd remote cron --json # tasks on servers: name, connection_name, cron_expr, enabled, next_due_at
wd remote cron run cleanup --json # run on the server now: { "ok", "last_exit", "log_tail" }
wd remote backup --json # server backups
wd remote backup run nightly --json
# { "ok", "status", "path", "size_bytes", "message" }
wd remote cron add cleanup --server prod --schedule "0 3 * * *" --command "php bin/console app:cleanup" --json
# also --file <script>, --run-by webdonkey|server, --paused
wd remote cron edit cleanup --schedule "30 3 * * *" --json
# only what is given changes: --name, --schedule, --command, --file, --run-by
wd remote cron delete cleanup -y --json
# a crontab line on the server goes too, ask first
wd remote backup add nightly --server prod --path www --db shop --schedule daily --at 02:30 --json
# --exclude, --to local|remote, --dest-path, --folder, --weekday, --cron, --keep, --name-pattern
wd remote backup edit nightly --keep 14 --json
# only what is given changes; a list given (--path, --db, --exclude) replaces the old one
wd remote backup delete nightly -y --json
# its archives stay unless --archives, ask first
```
Files, databases, logs and mailboxes on the servers (Premium). Relative
server paths start in the login folder:
```bash
wd remote sftp ls prod www --json # { "path", "entries": [{ "name", "path", "is_dir", "size", "mtime" }] }
wd remote sftp get prod www/.env ./env-prod --json
wd remote sftp put prod ./dist www/ --json
# a target ending in / means "into that folder"; overwriting asks (-y), ask first
wd remote db --json # entries of Remote databases: name, kind, connection_name, host, port, database
wd remote db databases shop --json
wd remote db backup shop --json # a dump into a file on this Mac (alias dump); --format, --folder
wd remote db restore shop shop_live ./shop.sql.gz -y --json
# backs the database up first, then replaces it (alias import), ask first
wd remote logs --json # remote logs: name, connection_name, path
wd remote logs tail error-log -n 50 --json
# reads over SSH now: { "lines" }; -f keeps reading every few seconds
wd remote mail --json # mailboxes
wd remote mail folders info --json
wd remote mail messages info --json
# newest mails: id, from_name, from_address, subject, date, seen (--folder, -n, --search)
wd remote mail show info 1 --json # one mail with headers, text and attachments; --id takes the id instead
```
A password or key passphrase goes in only through `--password-stdin` (first
line of stdin), never put one into an argument, and never ask the user for
one in the chat. A server backup refused with `remote_backup_space:…` lacks
space; `--force` runs it anyway, ask first.
### Monitor and SEO
```bash
wd monitor --json # { "projects", "targets", "online" }: last_status, last_latency_ms, ssl_expires_at
wd monitor check --json # check every address now
wd monitor check shop --json # one address
wd seo --json # SEO audits (add-on)
wd seo check shop --json # website check: { "final_url", "checks": [{ "code", "group", "state", "value" }] }
wd seo crawl shop --json # the audit's crawl; waits: { "status", "crawled", "found" } (--detach)
wd monitor add https://shop.example.com --label Shop --interval 5 --json
# --project, --keyword; a new address follows its project's switch
wd monitor edit Shop --keyword "Add to cart" --json # --url, --label, --project, --interval
wd monitor delete Shop -y --json # deletes its history, ask first
wd monitor auto off --json # "check automatically" for every project and address; without on/off: the state
wd monitor lighthouse Shop --profile mobile --json # waits; scores lh_* (mobile), lhd_* (desktop); --detach
```
`state` is `pass`, `warn`, `fail`, `info` or `unknown`.
### Workflows
```bash
wd workflows --json # name, enabled, last_status, next_run_at, locked_by_quota
wd workflows run deploy --json # waits; { "ok", "run": { "status", "error" }, "steps": [...] }
wd workflows run deploy --data '{"branch":"main"}' --json
# input fields of the manual start
wd workflows run deploy --detach --json # { "ok", "run_id" } at once
wd workflows runs deploy -n 5 --json
wd workflows disable deploy --json # wd workflows enable switches it on
```
A run that ends in `error` or `cancelled` exits with 1.
### Notes (Premium)
```bash
wd notes --json # [{ "rel_path", "name" }] of the active vault
wd notes show projects/shop --json # { "path", "content" }
wd notes new projects/shop "First line" --json # .md is added
echo "- check the contact form" | wd notes append projects/shop --json
```
### Virtual machines
```bash
wd vms --json # name, os_family, cpus, ram_mb, disk_gb, ssh_port, running
wd vms start ubuntu --json
wd vms stop ubuntu --json # ask first
wd vms create ubuntu --iso ~/Downloads/ubuntu.iso --cpus 4 --ram 8 --disk 64 --ssh-port 2222 --json
# --os linux|windows|bsd, --arch aarch64|x86_64 (default: this Mac's)
wd vms edit ubuntu --ram 4 --json # only while stopped; --name, --iso ("" ejects), --os, --arch, --cpus, --ssh-port
wd vms delete ubuntu -y --json # deletes its disk, ask first
```
### Mail (Mailpit)
```bash
wd mail --json # newest 20: { "total", "unread", "messages": [{ "ID", "From", "To", "Subject", "Created", "Read" }] }
wd mail list -n 5 --json
wd mail show 1 --json # the newest mail: From, To, Subject, Date, Text, HTML
```
Use it to check that a site really sent a mail. `mailpit_not_running` →
`wd services start mailpit`.
### AI
```bash
wd ai --json # chats: id, title, model, specialist_id, ctx_budget_gb, updated_at
wd ai rename "New chat" Shop checkout --json
wd ai configs --json # { "configs": [{ "id", "name", "model", "ctx_budget_gb", "specialist_id" }], "specialists": [{ "id", "name" }],
# "cli_configs": [{ "id", "name", "cli_id", "model", "ctx_budget_gb", "cwd" }] }
wd ai cli-add Shop --cli qwen-code --model qwen3:8b --memory 16 --folder ~/Sites/shop --json
# a CLI configuration of the CLI tab; --cli aider (default), qwen-code, codex-cli,
# goose, opencode, crush; --memory auto (default) or GB; --folder defaults to the current one
wd ai cli-delete Shop --json # ask first
wd ai models --json # { "ollama_running", "installed": [the local Ollama's models], "notes": [...] }
```
A CLI configuration needs Premium, like the CLI tab: on Free `cli-add` exits 4.
### MCP
```bash
wd mcp --json # configured servers: id, name, client, client_name, scope, project, transport, state, running, can
wd mcp clients --json # the AI clients: id, name, present, processes, sources
wd mcp disable "github · Claude Code" --json
# wd mcp enable switches it on again; the result's "reload" says when it takes effect
```
Name a server as `<name> · <client>` when several clients have one of that name.
### Subscriptions
```bash
wd subscriptions --json # { "subscriptions": [{ "name", "price_cents", "currency", "interval_unit", "next_due_at", "cancel_by", "status", … }], "totals": [...] }
wd subscriptions add Hosting --price 12 --every month --start 2026-01-15 --notice-days 30 --json
wd subscriptions delete Hosting -y --json
```
Free keeps a limited number of subscriptions: over it, `add` exits 4.
### Themes and settings
```bash
wd themes --json # { "active", "builtin", "presets", "custom": [{ "id", "name", "base", … }] }
wd themes use aurora --json # system | arctic | aurora | a preset (Premium) | an own theme by name
wd settings --json # language, theme, default_editor, default_sites_root, terminal_open, folder_open, code_open, db_open, remote_notices
wd settings get language --json
wd settings set language en --json
```
A value the setting does not take fails with the allowed ones in `message`.
### Claude Code
```bash
wd claude --json # installed, login, plan limits, running instances
wd claude sessions --json # running Claude instances: pid, name, cwd, kind, status, model, ctx_used_pct
wd claude usage --days 7 --json # tokens per day, estimated from local transcripts (Premium)
```
Plan limits (`limits.five_hour` / `limits.seven_day`: `used_pct`, `resets_at` in
ms) exist only after the user switched on the statusline bridge on the app's
Claude page; `limits` is null otherwise. None of these commands costs tokens.
`wd claude statusline` and `wd claude notify` are called by Claude itself,
do not run them.
### WebDonkey Editor
```bash
wd edit src/Checkout.php:42 # open a file at a line in the WebDonkey Editor
wd edit src/Checkout.php:42:7 # … and column
wd edit . # open the current folder as the editor's project
wd edit --diff a.php b.php # compare two files
wd edit --wait notes.md # blocks until the tab is closed (-w)
wd edit --terminal # a terminal in the editor, in the current folder
wd edit --terminal /abs/project # … in that folder
```
The editor is a separate app; `wd edit` starts it when it is not running and
answers `{"ok": true, "action": "edit" | "diff" | "terminal", ...}` with
`--json`. `--wait` holds until the user closes the tab, never use it for a
file you only want to show; it is meant for `$EDITOR`/`$VISUAL`.
### Diagnosis
```bash
wd doctor --json
```
```json
{ "ok": false, "checks": [
{ "name": "Site shop.test", "ok": false, "detail": "not running: nginx", "hint": "wd sites start shop.test" }
] }
```
Exit 1 when a check fails. Every failed check carries a `hint`, the command
that fixes it (ask before destructive ones).
### App pages
```bash
wd open services --json # bring the app to the front on a page
wd open "toolbox?tool=json" # a page with a query
```
Also accepted: home, config/configs, db, certs/ssl, tasks/scheduled-tasks,
api, ki, help/manual. Without a page a picker opens (terminal only).
Pages: dashboard, sites, certificates, services, configuration, databases,
remote-databases, mail, remote-mail, logs, custom-logs, remote-logs, docs,
legal, remote, notes, backups, remote-backups, cron, remote-cron, monitor,
subscriptions, api-client, workflows, toolbox, ai, claude, terminal, vms,
changelog, premium, themes, settings. Use this to show the user something, it does not change
anything.
### Front proxy, ports, the app
```bash
wd proxy --json # { "running": true, "last_error": null }
wd proxy start --json
wd proxy stop --json # sites stop answering on 80/443, ask first
wd free-port 3306 -y --json # stops a FOREIGN process on that port, ask first
wd app start --json # { "running": true, "app_version": "<version>", "launched": true }
wd app stop --json # quits the app and its services, ask first
```
### Shell completion
```bash
wd completions zsh # zsh, bash, fish, elvish or powershell
```
Prints a completion script for the user's shell configuration
(`source <(wd completions zsh)` in `~/.zshrc`). No `--json` (exit 2). Only
when the user asks for it.
### Removing WebDonkey from the Mac
```bash
wd uninstall -y --json # system parts only; sites, databases and settings stay
wd uninstall --delete-data -y --json # also delete WebDonkey's data once the app has quit
```
Removes what WebDonkey set up outside its data folder: sudoers rules, root
helpers, scheduling daemons, DNS resolver files, hosts entries, the trusted
root CA, the PATH block, the Claude statusline bridge, shell aliases, SSH
hosts and the prompt of the Terminal page. Project folders are never touched.
macOS asks the user for an administrator password once, on the Mac; then the
app quits. Without a terminal it needs `-y` (exit 2 otherwise).
```json
{ "removed": [{ "kind": "sudoers_rule", "path": "…", "privileged": true }],
"remaining": [], "errors": [] }
```
Exit 1 when something remains (`remaining` names it) or the password dialog
was cancelled (nothing changed then). **Only on the user's explicit request to
remove WebDonkey**: never to fix a problem.
## Errors
With `--json`, a failure prints exactly one object on stdout:
```json
{ "ok": false, "error": { "kind": "failed", "code": 1, "message": "…" } }
```
| Exit | kind | Meaning | What to do |
|---|---|---|---|
| 0 | none | success | continue |
| 1 | `failed` | the command ran and failed | read `message`; do not retry blindly |
| 1 | `app_outdated` | the app is older than this `wd` | tell the user to update WebDonkey |
| 2 | `usage` | wrong arguments, ambiguous name, missing `-y` | fix the call; `message` lists the candidates |
| 3 | `unreachable` | the app is not running | `wd app start`, then retry once |
| 4 | `premium` | needs WebDonkey Premium or an add-on, or a Free limit is reached | tell the user; `detail` says which (`addon_required:<package>`) |
Common patterns:
- **Port conflict**: a start fails with a message containing
`PORT_IN_USE:<port>:<process>` and `"hint": "wd free-port <port>"`.
Another program holds the port, often a second MySQL or web server the
user needs. Ask before running the hint.
- **Free limit**: `kind: "premium"` with `detail` like
`premium_service_limit:…`: the Free plan runs a limited number of
services at once. Stop one (ask which) or tell the user.
- **Site does not load**: check `wd sites --json` (is it `enabled`?), then
`wd services --json` (are its PHP and webserver `Running`?), then
`wd logs tail <webserver> -n 100 --json`.
## Typical flows
Bring a PHP project up:
```bash
wd status --json
wd sites start shop --json # starts PHP, webserver and databases for it
wd proxy --json # must be running for https://shop.test
```
Check a service before relying on it:
```bash
wd services --json | jq -r '.[] | select(.package_id=="mysql") | .status'
```
Investigate a failing site:
```bash
wd sites --json | jq '.[] | select(.domain=="shop.test") | {enabled, webserver, php_version}'
wd logs tail nginx -n 100 --json
wd logs tail php -n 100 --json
```
## Limits: do not work around these
- **Editing sites** (domain, aliases, environment), **uninstalling**
packages, editing configuration files: app UI only.
- **Creating and editing** workflows and SEO audits: app UI only. Listing,
running and switching them on or off works with `wd`. Tasks, backup
sets, monitored addresses and virtual machines can be
created and edited with `wd`, and so can tasks and backups on servers
(`wd remote cron add`, `wd remote backup add` …).
- **The toolbox, the API client, chatting with an AI model, adding or editing
MCP servers**: app UI only.
- `wd` only reaches the WebDonkey of the **same user on the same Mac**.
## Security
`wd` talks to a Unix socket inside the user's WebDonkey folder
(`~/Library/Application Support/WebDonkey/runtime/control.sock`, mode 0600):
no network port, no token. Everything you do with `wd` you do as the user,
so ask before anything that stops their work or kills a process.