YAML formatieren und validieren

So funktioniert es

In YAML macht ein einziges falsches Leerzeichen die ganze Datei ungültig: docker compose up oder ein GitHub-Actions-Workflow bricht nur mit einer knappen Meldung wie "yaml: line 7" ab. Fügen Sie den Dateiinhalt links ein. Ist der Text ungültig, nennt das Werkzeug die Zeile des ersten Fehlers und den Grund in verständlichen Worten: ein Tabulator in der Einrückung, ein Schlüssel, der im selben Block zweimal vorkommt, ein offenes Anführungszeichen oder eine offene eckige Klammer, oder Zeilen derselben Ebene mit unterschiedlich vielen Leerzeichen. Ist der Text gültig, wird er rechts mit einheitlicher Einrückung neu geschrieben: Im Beispiel rückt die um 8 Leerzeichen verschobene image-Zeile auf 4 zurück, Listenpunkte (- "8080:80") stehen zwei Leerzeichen unter ihrem Schlüssel, überzählige Leerzeichen verschwinden. Kommentare mit #, die Reihenfolge der Schlüssel und mehrere durch --- getrennte Dokumente bleiben erhalten. Die Ergebniszeile nennt die Zahl der Dokumente und Zeilen.

Dieses Werkzeug ist auch als yaml formatieren, yaml validieren, yaml pruefen online, yaml formatter, yaml validator, docker compose yaml pruefen bekannt.

Was ist YAML?

YAML (YAML Ain't Markup Language) ist ein Datenformat für Konfigurationsdateien, das Menschen lesen und schreiben können. Statt Klammern und Anführungszeichen nutzt es Einrückung: Zeilen der Form Schlüssel: Wert und Listenpunkte mit - verschachteln sich danach, wie weit sie eingerückt sind. Einstellungen für docker-compose, GitHub Actions, Kubernetes, Ansible und Home Assistant werden in YAML geschrieben. Anders als JSON erlaubt YAML Kommentare (#).

Was ist Einrückung?

In YAML ist die Einrückung die Zahl der Leerzeichen am Zeilenanfang, und sie ist Struktur, keine Optik: Zeilen unter einem Schlüssel, die mit mehr Leerzeichen beginnen, gehören zu ihm. Zeilen derselben Ebene müssen mit gleich vielen Leerzeichen beginnen. Wie viele Sie verwenden, ist frei (2 sind am häufigsten), ein Tabulatorzeichen wird aber nirgends als Einrückung akzeptiert.

Was ist der Unterschied zwischen YAML und JSON?

Beide transportieren dieselben Arten von Daten (Schlüssel und Werte, Listen, Zahlen, Text), und jedes JSON-Dokument ist zugleich gültiges YAML. Der Unterschied liegt in der Schreibweise: JSON baut Struktur mit geschweiften und eckigen Klammern, YAML mit Einrückung. YAML erlaubt Kommentare und Text ohne Anführungszeichen und wird deshalb für von Hand gepflegte Konfigurationsdateien bevorzugt. JSON ist strenger und dient dem Datenaustausch zwischen Programmen und in APIs. Zum Wechseln nutzen Sie das Werkzeug JSON in YAML.

Die häufigsten YAML-Fehler und was sie bedeuten

YAML liest Einrückung als Bedeutung: Mit wie vielen Leerzeichen eine Zeile beginnt, entscheidet, zu welchem Schlüssel sie gehört. Deshalb ist ein Tabulatorzeichen, wie es die Tab-Taste einfügt, verboten; es sieht aus wie Leerzeichen, aber YAML lehnt es ab. Beginnen zwei Zeilen derselben Ebene mit 2 und 3 Leerzeichen, schlägt die Datei fehl oder ergibt eine andere Struktur als gedacht.

Der zweithäufigste Fehler ist ein doppelter Schlüssel: zweimal ports: im selben Block. Manche Programme nehmen das stillschweigend hin und verwenden den zweiten, Ihre erste Einstellung geht verloren; dieses Werkzeug folgt der YAML-1.2-Regel, meldet einen Fehler und zeigt die Zeile. Der dritte ist ein fehlendes Leerzeichen nach dem Doppelpunkt: image:nginx ist kein Schlüssel mit Wert, sondern ein einziger Text.

• „Tabulatoren sind nicht erlaubt“ → Tab am Zeilenanfang durch Leerzeichen ersetzen
• „Schlüssel steht ein zweites Mal“ → eine der beiden Zeilen löschen oder zusammenführen
• „Anführungszeichen nicht geschlossen“ → " oder ' in der Zeile zählen

Was ändert das Neuschreiben, was bleibt?

Das Werkzeug liest die Datei und schreibt dieselben Daten neu: Die Einrückung wird einheitlich, Listenpunkte rücken eine Ebene unter ihren Schlüssel, überzählige Leerzeichen vor Kommentaren schrumpfen auf eines. Schlüssel, Werte, Kommentare und Reihenfolge bleiben; Text in Anführungszeichen wie "false" behält sie, denn ohne Anführungszeichen würde daraus ein Wahrheitswert.

Das alphabetische Sortieren ist optional und sortiert jeden Block für sich; ein Kommentar über einem Schlüssel wandert mit ihm. In docker-compose- oder Kubernetes-Dateien trägt die Reihenfolge keine Bedeutung, aber es gibt eine gewohnte Lesereihenfolge (image zuerst, ports danach); deshalb bleibt die Reihenfolge standardmäßig erhalten.

Häufige Fragen

Wie prüfe ich, ob meine YAML-Datei gültig ist?

Fügen Sie den Inhalt links auf dieser Seite ein. Ist er gültig, steht in der Ergebniszeile „Gültiges YAML“ und die Datei erscheint rechts sauber eingerückt. Ist er ungültig, sehen Sie Zeilennummer und Grund des ersten Fehlers.

Werden meine Kommentare entfernt?

Nein. Kommentarzeilen mit # und Kommentare am Zeilenende bleiben an ihrem Platz. Eine Umwandlung in JSON würde Kommentare löschen; dieses Werkzeug schreibt YAML wieder als YAML und behält sie.

Eignet es sich für docker-compose.yml und GitHub-Actions-Dateien?

Ja. Das Werkzeug prüft die allgemeinen YAML-Regeln; docker-compose-, GitHub-Actions-, Kubernetes-, Ansible- und Home-Assistant-Dateien sind alle YAML. Ob ein Schlüssel im jeweiligen Programm gültig ist, etwa eine falsch geschriebene Docker-Option, prüft es nicht.

Wird meine Datei an einen Server geschickt?

Nein. Prüfen und Formatieren laufen vollständig in Ihrem Browser; der eingefügte Text verlässt diese Seite nicht, auch nicht bei Konfigurationsdateien mit Passwörtern oder Schlüsseln.