README
¶
Chatwright CLI
The command-line entry point for Chatwright — deterministic and AI-driven testing for conversational applications.
Module chatwright.dev/cli, binary chatwright. The CLI is deliberately
thin: platform emulation and the testing runtime live in
chatwright.dev/runtime, and the
run-bundle wire model in
chatwright.dev/sdk; this binary
fronts them from a terminal.
Install
Canonical (macOS/Linux):
curl -fsSL https://chatwright.dev/install.sh | sh
Windows (PowerShell):
irm https://chatwright.dev/install.ps1 | iex
Homebrew (macOS — not yet published; the cask activates with a future release):
brew install --cask chatwright/tap/chatwright
Go-native:
go install chatwright.dev/cli/cmd/chatwright@latest
Usage
chatwright <command>
Commands:
platforms List built-in messaging platform emulators
arena Run and report on the actor-model arena (chatwright arena help)
version Print the CLI, runtime and sdk versions
help Show this help
chatwright version reports the CLI's own version plus the resolved
sdk/runtime module versions it was built against, and the supported
run-bundle format id.
Actor-model arena
Compares actor models (Ollama, LM Studio, any OpenAI-compatible endpoint)
on the same Chatwright scenario — see
chatwright.dev/runtime/arena
and spec/ideas/actor-model-arena.md
in the standard repository:
chatwright arena run --config arena.yaml --out ./arena-run
chatwright arena report --dir ./arena-run # recompute report.md later, no re-run
arena run writes bundles/ (one replayable run-bundle per cell),
report.md (the comparison table) and results.json (machine-readable) into
--out. See arena.example.yaml for a documented
starting config.
The Chatwright repositories
| Repository | What it holds |
|---|---|
| chatwright/chatwright | The standard: specs, formats, docs |
| chatwright/sdk-go | chatwright.dev/sdk — the run-bundle wire model |
| chatwright/runtime-go | chatwright.dev/runtime — the engine |
| chatwright/cli (this repo) | chatwright.dev/cli — this CLI |
| chatwright/studio | Chatwright Studio and the chatwright.dev site |
Licence
Apache-2.0 — see LICENSE and NOTICE.
Spec-first
Chatwright is developed spec-first with SpecScore —
product specs live in the standard repository;
this repository's own specs live under spec/.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
chatwright
command
arena.go wires chatwright.dev/runtime/arena into the CLI as `chatwright arena run` and `chatwright arena report`.
|
arena.go wires chatwright.dev/runtime/arena into the CLI as `chatwright arena run` and `chatwright arena report`. |
|
internal
|
|
|
server
daemon.go implements the process lifecycle behind `chatwright server start`/`stop`: writing and reading a PID file, detecting a stale one (the recorded process no longer exists), re-executing this same binary as a detached `server serve` child, and terminating it again.
|
daemon.go implements the process lifecycle behind `chatwright server start`/`stop`: writing and reading a PID file, detecting a stale one (the recorded process no longer exists), re-executing this same binary as a detached `server serve` child, and terminating it again. |