Kommandozeile rt
rt läuft mit demselben Kern wie die Apps: Was in der App grün ist, ist in der Pipeline grün. Die Ausgabe ist für Programme gemacht – JSON auf stdout, Exit-Codes, die eine Pipeline versteht – und Secrets gibst du als Variablen der Pipeline mit, nie in den Dateien.
- Edition
- Free
- Systeme
- macOS, Linux x86_64 und aarch64
- Dazu
- Docker-Image, GitHub Action
- Ausgabe
- JSON-Bericht, JUnit, Text
- Exit-Codes
- 0 bis 4
Die Befehle
| Befehl | Wofür |
|---|---|
rt send | Einen Request senden; JSON-Bericht auf stdout |
rt run | Eine Collection oder einen Ordner der Reihe nach senden, mit Tests und Assertions |
rt import | Exporte anderer Werkzeuge in einen Collection-Ordner umwandeln |
rt scan | Collection-Dateien auf Zugangsdaten prüfen |
rt mock | Mit den gespeicherten Beispielen antworten, als Mock-Server |
rt docs | Eine statische HTML-Seite aus der Collection schreiben |
rt mcp, rt approvals, rt approve, rt deny | MCP-Server für KI-Agenten und seine Freigaben (KI-Agenten und MCP-Server) |
rt mcp-test | Gespeicherte MCP-Tests ausführen (MCP-Client) |
rt agent | Begleitdienst für die Web-App (Begleitdienst rt agent) |
rt --help und rt <befehl> --help zeigen alle Optionen. Die Downloads für macOS und Linux stehen auf der Download-Seite.
rt send
rt send <request-datei> [--env NAME] [--var NAME=WERT]... [--pretty]
Die Collection ist der nächste Ordner oberhalb der Request-Datei, der eine opencollection.yml enthält.
| Option | Bedeutung |
|---|---|
-e, --env NAME | Die Umgebung NAME verwenden |
--var NAME=WERT | Laufzeit-Variable mit dem höchsten Rang, wiederholbar – für Secrets aus der Pipeline oder einen anderen Host |
--body-limit BYTES | Höchstens so viele Bytes des Bodys in den Bericht (Standard 10 MiB) |
--plugin DATEI.wasm, --no-plugins | Ein Plugin zusätzlich ausführen bzw. die installierten nicht |
--cookie-jar DATEI | Cookies aus der Datei senden und neue darin speichern |
--no-prompt | Scheitern statt auf eine OAuth-Anmeldung zu warten (Pipelines) |
--no-scripts | Skripte der Collection nicht ausführen; Assertions laufen trotzdem |
--pretty | JSON einrücken |
Die Ausgabe ist ein JSON-Objekt, der Bericht über den Versand: was auf die Leitung ging (Secrets als ***), die Antwort mit Status, Headern, Body und Zeiten, die verwendeten Variablen mit Herkunft, Platzhalter ohne Wert, Ergebnisse von Tests und Assertions und ein etwaiger Fehler. Die Web-App liefert denselben Bericht. WebSocket, gRPC und SSE (--sse) öffnen Sitzungen; dazu gRPC, WebSocket, SSE und GraphQL.
rt send health/status.yml --env CI --var token="$API_TOKEN" \
| jq -e '.response.status == 200'
rt run
rt run sendet alle Requests einer Collection oder eines Ordners der Reihe nach und meldet Tests und Assertions – der Befehl für Pipelines. Variablen, die Skripte setzen, gelten für die folgenden Requests des Laufs, nie in den Dateien.
rt run # die Collection (oder der Ordner), in der du bist
rt run api/users -e Staging --var token=$API_TOKEN
rt run . --data users.csv --reporter junit=reports/junit.xml --reporter json=reports/run.json
| Option | Bedeutung |
|---|---|
--data DATEI | CSV oder JSON; jede Zeile ist eine Iteration mit eigenen Variablen |
--iterations N | Die Requests N-mal senden |
--delay MS | Zwischen den Requests warten |
--bail | Beim ersten Fehlschlag aufhören |
--reporter NAME[=DATEI] | text, json oder junit, wiederholbar |
junit schreibt JUnit-XML, wie GitHub, GitLab und Jenkins es lesen: eine Testsuite je Request, ein Testfall je Test und Assertion. json enthält je Schritt den vollständigen, maskierten Bericht von rt send. text läuft immer mit, eine Zeile je Request auf stderr.
Exit-Codes
| Code | rt send | rt run |
|---|---|---|
| 0 | Eine Antwort kam, egal mit welchem HTTP-Status | Alle Requests beantwortet, alle Tests und Assertions bestanden |
| 1 | Keine Antwort: Verbindung, DNS, TLS, Zeitlimit, zu viele Weiterleitungen | Kein Netz-Stack |
| 2 | Aufruffehler, keine Collection, ungültige Dateien, Request nicht in der Collection | Aufruffehler, unbekannte Umgebung, unlesbare Datendatei |
| 3 | Request nicht vorbereitbar: unbekannte Umgebung, ungültige URL, Auth gescheitert, Plugin oder Skript hat abgebrochen | Externe Secrets oder Plugins nicht einrichtbar |
| 4 | Antwort kam, aber ein Test oder eine Assertion scheiterte | Ein Request, Test oder eine Assertion scheiterte |
In der Pipeline
Secrets gibst du als Variablen des Jobs an --var; in die Collection schreibst du sie nie. Mit --no-prompt scheitert ein OAuth-Flow, der eine Person braucht, statt zu warten.
GitHub Actions, mit der Action aus dem Repo des Kerns:
- uses: clouddnagmbh/requesttailor/github-action@v1
with:
collection: api
environment: Staging
junit: reports/junit.xml
env:
RT_VAR_token: ${{ secrets.API_TOKEN }}
GitLab CI oder jede andere Umgebung mit Docker, mit dem Image ghcr.io/clouddnagmbh/rt (minimal, ohne Shell, als Nutzer ohne Root-Rechte):
docker run --rm -v "$PWD:/work" ghcr.io/clouddnagmbh/rt run . --reporter junit=junit.xml
rt import
rt import shop.postman_collection.json prod.postman_environment.json --out ./shop
rt import api.yaml --format openapi --out ./api --json
Druckt den Verlustbericht. Exit-Code 0, sobald die Collection geschrieben ist, 2, wenn die Eingabe nicht lesbar oder --out nicht leer ist. Details in Import auf der Kommandozeile.
rt scan
Findet Zugangsdaten in Collection-Dateien, bevor sie in Git landen – derselbe Scanner, den die App vor jedem Commit laufen lässt. Exit-Code 0 ohne Funde, 1 mit Funden, 2, wenn ein Pfad nicht lesbar ist. Der Wert eines Fundes wird nie ausgegeben. Als Git-Hook vor dem Commit (.git/hooks/pre-commit, ausführbar):
#!/bin/sh
files=$(git diff --cached --name-only --diff-filter=ACMR -- '*.yml' '*.yaml' '*.json')
[ -z "$files" ] && exit 0
exec rt scan $files
rt mock und rt docs
Requests können Beispiele speichern: einen Request und die Antwort darauf (auch aus dem Postman-Import). rt mock antwortet damit, sodass App, Frontend oder Tests arbeiten können, bevor der echte Dienst existiert:
rt mock . --env Local --port 4010
Ein eingehender Request passt zu einem Beispiel über Methode und Pfad; passen mehrere, gewinnt das, dessen gespeicherter Request am besten passt. Ohne Treffer gibt es 404 mit einer Liste aller Routen. Der Mock hört auf 127.0.0.1, wenn du nicht --host angibst.
rt docs . --out site schreibt eine statische HTML-Seite mit Stylesheet: Ordner, Requests mit Methode, URL, Beschreibung, Parametern, Headern, Body, Auth-Art und Beispielen. Secret-Werte erscheinen nie; was nach Zugangsdaten aussieht, steht als *** da.
Siehe auch
- Funktionen im Überblick Funktionen · tests
- Doku Skripte, Tests und Runner
- Doku Import
- Doku KI-Agenten und MCP-Server
- Doku Begleitdienst rt agent
- Belege Runner1 · rt mock und rt docs2 · Plattformen3