Documentation Index
Fetch the complete documentation index at: https://docs.openclaw.ai/llms.txt
Use this file to discover all available pages before exploring further.
- Vollständiges Test-Kit (Suites, Live, Docker): Tests
- Update- und Plugin-Paketvalidierung: Updates und Plugins testen
-
pnpm test:force: Beendet alle verbleibenden Gateway-Prozesse, die den Standard-Control-Port belegen, und führt dann die vollständige Vitest-Suite mit einem isolierten Gateway-Port aus, damit Server-Tests nicht mit einer laufenden Instanz kollidieren. Verwenden Sie dies, wenn ein vorheriger Gateway-Lauf Port 18789 belegt gelassen hat. -
pnpm test:coverage: Führt die Unit-Suite mit V8-Coverage aus (übervitest.unit.config.ts). Dies ist ein Coverage-Gate für die Standard-Unit-Lane, keine dateiübergreifende Coverage des gesamten Repos. Die Schwellenwerte liegen bei 70 % für Zeilen/Funktionen/Anweisungen und 55 % für Branches. Dacoverage.allfalse ist und die Standard-Lane die Coverage-Includes auf nicht schnelle Unit-Tests mit benachbarten Quelldateien eingrenzt, misst das Gate den von dieser Lane verantworteten Source-Code statt jedes transitiven Imports, den sie zufällig lädt. -
pnpm test:coverage:changed: Führt Unit-Coverage nur für Dateien aus, die seitorigin/maingeändert wurden. -
pnpm test:changed: günstiger intelligenter geänderter Testlauf. Er führt präzise Ziele aus direkten Teständerungen, benachbarten*.test.ts-Dateien, expliziten Source-Mappings und dem lokalen Importgraphen aus. Breite/config/package-Änderungen werden übersprungen, sofern sie nicht präzisen Tests zugeordnet werden. -
OPENCLAW_TEST_CHANGED_BROAD=1 pnpm test:changed: expliziter breiter geänderter Testlauf. Verwenden Sie dies, wenn eine Änderung an Test-Harness/config/package auf Vitests breiteres Changed-Test-Verhalten zurückfallen soll. -
pnpm changed:lanes: zeigt die architektonischen Lanes, die durch den Diff gegenorigin/mainausgelöst werden. -
pnpm check:changed: führt das intelligente Changed-Check-Gate für den Diff gegenorigin/mainaus. Es führt Typecheck-, Lint- und Guard-Befehle für die betroffenen architektonischen Lanes aus, führt aber keine Vitest-Tests aus. Verwenden Siepnpm test:changedoder ein explizitespnpm test <target>als Testnachweis. -
pnpm test: leitet explizite Datei-/Verzeichnisziele durch Vitest-Lanes mit passendem Scope. Läufe ohne Ziel verwenden feste Shard-Gruppen und erweitern sich für lokale parallele Ausführung auf Leaf-Configs; die Extension-Gruppe erweitert sich immer auf die Shard-Configs pro Extension statt auf einen einzigen riesigen Root-Project-Prozess. -
Test-Wrapper-Läufe enden mit einer kurzen Zusammenfassung
[test] passed|failed|skipped ... in .... Vitests eigene Dauerzeile bleibt das Detail pro Shard. -
Gemeinsamer OpenClaw-Testzustand: Verwenden Sie
src/test-utils/openclaw-test-state.tsaus Vitest, wenn ein Test ein isoliertesHOME,OPENCLAW_STATE_DIR,OPENCLAW_CONFIG_PATH, eine Config-Fixture, einen Workspace, ein Agent-Verzeichnis oder einen Auth-Profile-Store benötigt. -
Prozess-E2E-Helfer: Verwenden Sie
test/helpers/openclaw-test-instance.ts, wenn ein Vitest-E2E-Test auf Prozessebene ein laufendes Gateway, CLI-Env, Log-Erfassung und Cleanup an einer Stelle benötigt. -
Docker-/Bash-E2E-Helfer: Lanes, die
scripts/lib/docker-e2e-image.shsourcen, könnendocker_e2e_test_state_shell_b64 <label> <scenario>in den Container übergeben und mitscripts/lib/openclaw-e2e-instance.shdekodieren; Multi-Home-Skripte könnendocker_e2e_test_state_function_b64übergeben und in jedem Flowopenclaw_test_state_create <label> <scenario>aufrufen. Low-Level-Aufrufer könnenscripts/lib/openclaw-test-state.mjs shell --label <name> --scenario <name>für ein Shell-Snippet im Container verwenden odernode scripts/lib/openclaw-test-state.mjs -- create --label <name> --scenario <name> --env-file <path> --jsonfür eine sourcebare Host-Env-Datei. Das--vorcreateverhindert, dass neuere Node-Runtimes--env-fileals Node-Flag behandeln. Docker-/Bash-Lanes, die ein Gateway starten, können im Containerscripts/lib/openclaw-e2e-instance.shsourcen, um Entrypoint-Auflösung, Mock-OpenAI-Start, Gateway-Start im Vordergrund/Hintergrund, Readiness-Probes, State-Env-Export, Log-Dumps und Prozess-Cleanup zu erhalten. -
Vollständige, Extension- und Include-Pattern-Shard-Läufe aktualisieren lokale Timing-Daten in
.artifacts/vitest-shard-timings.json; spätere Whole-Config-Läufe nutzen diese Timings, um langsame und schnelle Shards auszubalancieren. Include-Pattern-CI-Shards hängen den Shard-Namen an den Timing-Schlüssel an, wodurch gefilterte Shard-Timings sichtbar bleiben, ohne Whole-Config-Timing-Daten zu ersetzen. Setzen SieOPENCLAW_TEST_PROJECTS_TIMINGS=0, um das lokale Timing-Artefakt zu ignorieren. -
Ausgewählte
plugin-sdk- undcommands-Testdateien werden jetzt über dedizierte leichte Lanes geleitet, die nurtest/setup.tsbeibehalten, während laufzeitintensive Fälle auf ihren bestehenden Lanes bleiben. -
Quelldateien mit benachbarten Tests werden zuerst diesem benachbarten Test zugeordnet, bevor auf breitere Verzeichnis-Globs zurückgefallen wird. Helferänderungen unter
src/channels/plugins/contracts/test-helpers,src/plugin-sdk/test-helpersundsrc/plugins/contractsverwenden einen lokalen Importgraphen, um importierende Tests auszuführen, statt jeden Shard breit auszuführen, wenn der Abhängigkeitspfad präzise ist. -
auto-replywird jetzt außerdem in drei dedizierte Configs aufgeteilt (core,top-level,reply), damit der Reply-Harness die leichteren Top-Level-Status-/Token-/Helfer-Tests nicht dominiert. -
Die Basis-Vitest-Config verwendet jetzt standardmäßig
pool: "threads"undisolate: false, wobei der gemeinsame nicht isolierte Runner in allen Repo-Configs aktiviert ist. -
pnpm test:channelsführtvitest.channels.config.tsaus. -
pnpm test:extensionsundpnpm test extensionsführen alle Extension-/Plugin-Shards aus. Schwere Channel-Plugins, das Browser-Plugin und OpenAI laufen als dedizierte Shards; andere Plugin-Gruppen bleiben gebündelt. Verwenden Siepnpm test extensions/<id>für eine Lane eines einzelnen gebündelten Plugins. -
pnpm test:perf:imports: aktiviert Vitest-Berichte zu Importdauer und Importaufschlüsselung, nutzt aber weiterhin das Scoped-Lane-Routing für explizite Datei-/Verzeichnisziele. -
pnpm test:perf:imports:changed: dieselbe Import-Profilerstellung, aber nur für Dateien, die seitorigin/maingeändert wurden. -
pnpm test:perf:changed:bench -- --ref <git-ref>benchmarked den gerouteten Changed-Mode-Pfad gegen den nativen Root-Project-Lauf für denselben committed Git-Diff. -
pnpm test:perf:changed:bench -- --worktreebenchmarked die aktuelle Worktree-Änderungsmenge, ohne vorher zu committen. -
pnpm test:perf:profile:main: schreibt ein CPU-Profil für den Vitest-Hauptthread (.artifacts/vitest-main-profile). -
pnpm test:perf:profile:runner: schreibt CPU- und Heap-Profile für den Unit-Runner (.artifacts/vitest-runner-profile). -
pnpm test:perf:groups --full-suite --allow-failures --output .artifacts/test-perf/baseline-before.json: führt jede Full-Suite-Vitest-Leaf-Config seriell aus und schreibt gruppierte Dauerdaten sowie JSON-/Log-Artefakte pro Config. Der Test Performance Agent nutzt dies als Baseline, bevor er Korrekturen für langsame Tests versucht. -
pnpm test:perf:groups:compare .artifacts/test-perf/baseline-before.json .artifacts/test-perf/after-agent.json: vergleicht gruppierte Berichte nach einer performanceorientierten Änderung. -
Gateway-Integration: Opt-in über
OPENCLAW_TEST_INCLUDE_GATEWAY=1 pnpm testoderpnpm test:gateway. -
pnpm test:e2e: Führt Gateway-End-to-End-Smoke-Tests aus (Multi-Instance-WS/HTTP/node-Pairing). Verwendet standardmäßigthreads+isolate: falsemit adaptiven Workern invitest.e2e.config.ts; feinabstimmbar mitOPENCLAW_E2E_WORKERS=<n>undOPENCLAW_E2E_VERBOSE=1für ausführliche Logs. -
pnpm test:live: Führt Provider-Live-Tests aus (minimax/zai). Erfordert API-Schlüssel undLIVE=1(oder Provider-spezifisch*_LIVE_TEST=1), um das Überspringen aufzuheben. -
pnpm test:docker:all: Baut das gemeinsame Live-Test-Image, paketiert OpenClaw einmal als npm-Tarball, baut/verwendet ein Bare-Node-/Git-Runner-Image sowie ein funktionales Image, das diesen Tarball nach/appinstalliert, und führt dann Docker-Smoke-Lanes mitOPENCLAW_SKIP_DOCKER_BUILD=1über einen gewichteten Scheduler aus. Das Bare-Image (OPENCLAW_DOCKER_E2E_BARE_IMAGE) wird für Installer-/Update-/Plugin-Abhängigkeits-Lanes verwendet; diese Lanes mounten den vorgebauten Tarball, statt kopierte Repo-Quellen zu verwenden. Das funktionale Image (OPENCLAW_DOCKER_E2E_FUNCTIONAL_IMAGE) wird für normale Built-App-Funktions-Lanes verwendet.scripts/package-openclaw-for-docker.mjsist der einzige lokale/CI-Package-Packer und validiert den Tarball sowiedist/postinstall-inventory.json, bevor Docker ihn verwendet. Docker-Lane-Definitionen liegen inscripts/lib/docker-e2e-scenarios.mjs; die Planner-Logik liegt inscripts/lib/docker-e2e-plan.mjs;scripts/test-docker-all.mjsführt den ausgewählten Plan aus.node scripts/test-docker-all.mjs --plan-jsongibt den schedulerverwalteten CI-Plan für ausgewählte Lanes, Image-Arten, Package-/Live-Image-Bedarfe, State-Szenarien und Credential-Prüfungen aus, ohne Docker zu bauen oder auszuführen.OPENCLAW_DOCKER_ALL_PARALLELISM=<n>steuert Prozess-Slots und ist standardmäßig 10;OPENCLAW_DOCKER_ALL_TAIL_PARALLELISM=<n>steuert den providerempfindlichen Tail-Pool und ist standardmäßig 10. Schwere Lane-Caps sind standardmäßigOPENCLAW_DOCKER_ALL_LIVE_LIMIT=9,OPENCLAW_DOCKER_ALL_NPM_LIMIT=10undOPENCLAW_DOCKER_ALL_SERVICE_LIMIT=7; Provider-Caps sind standardmäßig eine schwere Lane pro Provider überOPENCLAW_DOCKER_ALL_LIVE_CLAUDE_LIMIT=4,OPENCLAW_DOCKER_ALL_LIVE_CODEX_LIMIT=4undOPENCLAW_DOCKER_ALL_LIVE_GEMINI_LIMIT=4. Verwenden SieOPENCLAW_DOCKER_ALL_WEIGHT_LIMIToderOPENCLAW_DOCKER_ALL_DOCKER_LIMITfür größere Hosts. Wenn eine Lane auf einem Host mit niedriger Parallelität das effektive Gewichts- oder Ressourcen-Cap überschreitet, kann sie trotzdem aus einem leeren Pool starten und läuft allein, bis sie Kapazität freigibt. Lane-Starts werden standardmäßig um 2 Sekunden versetzt, um lokale Docker-Daemon-Erstellungsstürme zu vermeiden; überschreiben Sie dies mitOPENCLAW_DOCKER_ALL_START_STAGGER_MS=<ms>. Der Runner führt standardmäßig einen Docker-Preflight aus, bereinigt veraltete OpenClaw-E2E-Container, gibt alle 30 Sekunden den Active-Lane-Status aus, teilt Provider-CLI-Tool-Caches zwischen kompatiblen Lanes, wiederholt transiente Live-Provider-Fehler standardmäßig einmal (OPENCLAW_DOCKER_ALL_LIVE_RETRIES=<n>) und speichert Lane-Timings in.artifacts/docker-tests/lane-timings.jsonfür Longest-First-Reihenfolge bei späteren Läufen. Verwenden SieOPENCLAW_DOCKER_ALL_DRY_RUN=1, um das Lane-Manifest auszugeben, ohne Docker auszuführen,OPENCLAW_DOCKER_ALL_STATUS_INTERVAL_MS=<ms>, um die Statusausgabe abzustimmen, oderOPENCLAW_DOCKER_ALL_TIMINGS=0, um die Timing-Wiederverwendung zu deaktivieren. Verwenden SieOPENCLAW_DOCKER_ALL_LIVE_MODE=skipnur für deterministische/lokale Lanes oderOPENCLAW_DOCKER_ALL_LIVE_MODE=onlynur für Live-Provider-Lanes; Package-Aliase sindpnpm test:docker:local:allundpnpm test:docker:live:all. Der Live-Only-Modus führt Main- und Tail-Live-Lanes in einem Longest-First-Pool zusammen, sodass Provider-Buckets Claude-, Codex- und Gemini-Arbeit gemeinsam packen können. Der Runner plant nach dem ersten Fehler keine neuen gepoolten Lanes mehr, sofernOPENCLAW_DOCKER_ALL_FAIL_FAST=0nicht gesetzt ist, und jede Lane hat ein 120-Minuten-Fallback-Timeout, das mitOPENCLAW_DOCKER_ALL_LANE_TIMEOUT_MSüberschrieben werden kann; ausgewählte Live-/Tail-Lanes verwenden engere Caps pro Lane. CLI-Backend-Docker-Setup-Befehle haben ein eigenes Timeout überOPENCLAW_LIVE_CLI_BACKEND_SETUP_TIMEOUT_SECONDS(Standard 180). Logs pro Lane,summary.json,failures.jsonund Phase-Timings werden unter.artifacts/docker-tests/<run-id>/geschrieben; verwenden Siepnpm test:docker:timings <summary.json>, um langsame Lanes zu untersuchen, undpnpm test:docker:rerun <run-id|summary.json|failures.json>, um günstige gezielte Rerun-Befehle auszugeben. -
pnpm test:docker:browser-cdp-snapshot: Baut einen Chromium-gestützten Source-E2E-Container, startet rohes CDP plus ein isoliertes Gateway, führtbrowser doctor --deepaus und verifiziert, dass CDP-Rollen-Snapshots Link-URLs, cursor-promoted Clickables, iframe-Refs und Frame-Metadaten enthalten. -
pnpm test:docker:skill-install: Installiert den paketierten OpenClaw-Tarball in einem Bare-Docker-Runner, deaktiviertskills.install.allowUploadedArchives, löst einen aktuellen Skill-Slug aus der Live-ClawHub-Suche auf, installiert ihn überopenclaw skills installund verifiziertSKILL.md,.clawhub/origin.json,.clawhub/lock.jsonundskills info --json. -
CLI-Backend-Live-Docker-Probes können als fokussierte Lanes ausgeführt werden, zum Beispiel
pnpm test:docker:live-cli-backend:codex,pnpm test:docker:live-cli-backend:codex:resumeoderpnpm test:docker:live-cli-backend:codex:mcp. Claude und Gemini haben entsprechende Aliase:resumeund:mcp. -
pnpm test:docker:openwebui: Startet dockerisiertes OpenClaw + Open WebUI, meldet sich über Open WebUI an, prüft/api/modelsund führt dann einen echten proxied Chat über/api/chat/completionsaus. Erfordert einen nutzbaren Live-Model-Schlüssel (zum Beispiel OpenAI in~/.profile), zieht ein externes Open-WebUI-Image und ist nicht erwartbar CI-stabil wie die normalen Unit-/E2E-Suites. -
pnpm test:docker:mcp-channels: Startet einen vorbereiteten Gateway-Container und einen zweiten Client-Container, deropenclaw mcp servestartet, und verifiziert anschließend die Erkennung gerouteter Konversationen, Transkript-Lesevorgänge, Anhangsmetadaten, das Verhalten der Live-Ereigniswarteschlange, das Routing ausgehender Sends sowie Kanal- und Berechtigungsbenachrichtigungen im Claude-Stil über die echte stdio-Brücke. Die Assertion für die Claude-Benachrichtigung liest die rohen stdio-MCP-Frames direkt, damit der Smoke-Test widerspiegelt, was die Brücke tatsächlich ausgibt. -
pnpm test:docker:upgrade-survivor: Installiert den gepackten OpenClaw-Tarball über ein verschmutztes Fixture eines alten Benutzers, führt eine Paketaktualisierung plus nicht interaktiven Doctor ohne Live-Provider- oder Kanalschlüssel aus, startet dann ein Loopback-Gateway und prüft, dass Agents, Kanalkonfiguration, Plugin-Allowlists, Workspace-/Sitzungsdateien, veralteter Legacy-Plugin-Abhängigkeitszustand, Startvorgang und RPC-Status erhalten bleiben. -
pnpm test:docker:published-upgrade-survivor: Installiert standardmäßigopenclaw@latest, bereitet realistische Dateien eines bestehenden Benutzers ohne Live-Provider- oder Kanalschlüssel vor, konfiguriert diese Baseline mit einem eingebettetenopenclaw config set-Befehlsrezept, aktualisiert diese veröffentlichte Installation auf den gepackten OpenClaw-Tarball, führt den nicht interaktiven Doctor aus, schreibt.artifacts/upgrade-survivor/summary.json, startet dann ein Loopback-Gateway und prüft, dass konfigurierte Intents, Workspace-/Sitzungsdateien, veraltete Plugin-Konfiguration und Legacy-Abhängigkeitszustand, Startvorgang,/healthz,/readyzund RPC-Status erhalten bleiben oder sauber repariert werden. Überschreiben Sie eine Baseline mitOPENCLAW_UPGRADE_SURVIVOR_BASELINE_SPEC, erweitern Sie eine exakte lokale Matrix mitOPENCLAW_UPGRADE_SURVIVOR_BASELINE_SPECSwieopenclaw@2026.5.2 openclaw@2026.4.23 openclaw@2026.4.15, oder fügen Sie Szenario-Fixtures mitOPENCLAW_UPGRADE_SURVIVOR_SCENARIOS=reported-issueshinzu; das Set reported-issues enthältconfigured-plugin-installs, um zu verifizieren, dass konfigurierte externe OpenClaw-Plugins während des Upgrades automatisch installiert werden, sowiestale-source-plugin-shadow, um zu verhindern, dass reine Source-Plugin-Schatten den Startvorgang beschädigen. Package Acceptance stellt diese alspublished_upgrade_survivor_baseline,published_upgrade_survivor_baselinesundpublished_upgrade_survivor_scenariosbereit und löst Meta-Baseline-Tokens wielast-stable-4oderall-since-2026.4.23auf, bevor exakte Paketspezifikationen an Docker-Lanes übergeben werden. -
pnpm test:docker:update-migration: Führt den Published-Upgrade-Survivor-Harness im bereinigungsintensiven Szenarioplugin-deps-cleanupaus und beginnt standardmäßig beiopenclaw@2026.4.23. Der separate WorkflowUpdate Migrationerweitert diese Lane mitbaselines=all-since-2026.4.23, sodass jedes stabile veröffentlichte Paket ab.23auf den Kandidaten aktualisiert wird und die Bereinigung konfigurierter Plugin-Abhängigkeiten außerhalb der Full-Release-CI nachweist. -
pnpm test:docker:plugins: Führt Installations-/Update-Smoke-Tests für lokalen Pfad,file:, npm-Registry-Pakete mit gehoisteten Abhängigkeiten, bewegliche Git-Refs, ClawHub-Fixtures, Marketplace-Updates sowie Aktivieren/Prüfen des Claude-Bundles aus.
Lokales PR-Gate
Führen Sie für lokale PR-Lande-/Gate-Prüfungen aus:pnpm check:changedpnpm checkpnpm check:test-typespnpm buildpnpm testpnpm check:docs
pnpm test auf einem ausgelasteten Host flakyt, führen Sie es einmal erneut aus, bevor Sie es als Regression behandeln, und isolieren Sie es dann mit pnpm test <path/to/test>. Verwenden Sie für Hosts mit begrenztem Arbeitsspeicher:
OPENCLAW_VITEST_MAX_WORKERS=1 pnpm testOPENCLAW_VITEST_FS_MODULE_CACHE_PATH=/tmp/openclaw-vitest-cache pnpm test:changed
Benchmark für Modelllatenz (lokale Schlüssel)
Skript:scripts/bench-model.ts
Verwendung:
source ~/.profile && pnpm tsx scripts/bench-model.ts --runs 10- Optionale Umgebungsvariablen:
MINIMAX_API_KEY,MINIMAX_BASE_URL,MINIMAX_MODEL,ANTHROPIC_API_KEY - Standard-Prompt: “Antworte mit einem einzelnen Wort: ok. Keine Satzzeichen oder zusätzlicher Text.”
- minimax Median 1279ms (Min. 1114, Max. 2431)
- opus Median 2454ms (Min. 1224, Max. 3170)
CLI-Start-Benchmark
Skript:scripts/bench-cli-startup.ts
Verwendung:
pnpm test:startup:benchpnpm test:startup:bench:smokepnpm test:startup:bench:savepnpm test:startup:bench:updatepnpm test:startup:bench:checkpnpm tsx scripts/bench-cli-startup.tspnpm tsx scripts/bench-cli-startup.ts --runs 12pnpm tsx scripts/bench-cli-startup.ts --preset realpnpm tsx scripts/bench-cli-startup.ts --preset real --case status --case gatewayStatus --runs 3pnpm tsx scripts/bench-cli-startup.ts --preset real --case tasksJson --case tasksListJson --case tasksAuditJson --runs 3pnpm tsx scripts/bench-cli-startup.ts --entry openclaw.mjs --entry-secondary dist/entry.js --preset allpnpm tsx scripts/bench-cli-startup.ts --preset all --output .artifacts/cli-startup-bench-all.jsonpnpm tsx scripts/bench-cli-startup.ts --preset real --case gatewayStatusJson --output .artifacts/cli-startup-bench-smoke.jsonpnpm tsx scripts/bench-cli-startup.ts --preset real --cpu-prof-dir .artifacts/cli-cpupnpm tsx scripts/bench-cli-startup.ts --json
startup:--version,--help,health,health --json,status --json,statusreal:health,status,status --json,sessions,sessions --json,tasks --json,tasks list --json,tasks audit --json,agents list --json,gateway status,gateway status --json,gateway health --json,config get gateway.portall: beide Voreinstellungen
sampleCount, Durchschnitt, p50, p95, Min./Max., Exit-Code-/Signalverteilung und Max-RSS-Zusammenfassungen für jeden Befehl. Optionales --cpu-prof-dir / --heap-prof-dir schreibt V8-Profile pro Lauf, sodass Timing und Profilerfassung denselben Harness verwenden.
Konventionen für gespeicherte Ausgaben:
pnpm test:startup:bench:smokeschreibt das gezielte Smoke-Artefakt nach.artifacts/cli-startup-bench-smoke.jsonpnpm test:startup:bench:saveschreibt das Artefakt der vollständigen Suite nach.artifacts/cli-startup-bench-all.jsonmitruns=5undwarmup=1pnpm test:startup:bench:updateaktualisiert die eingecheckte Baseline-Fixture untertest/fixtures/cli-startup-bench.jsonmitruns=5undwarmup=1
test/fixtures/cli-startup-bench.json- Aktualisieren mit
pnpm test:startup:bench:update - Aktuelle Ergebnisse mit
pnpm test:startup:bench:checkgegen die Fixture vergleichen
Onboarding-E2E (Docker)
Docker ist optional; dies wird nur für containerisierte Onboarding-Smoke-Tests benötigt. Vollständiger Kaltstart-Ablauf in einem sauberen Linux-Container:openclaw health aus.