RESTest documentation

One page per subject. The README at the root of the repository installs the tool and makes a first run, and the manual is read from beginning to end. These pages are what to look things up in afterwards.

Reference

Page	What it covers
The command line	Every command, every option of a run, the environment variables, how to stop a run, and the number a run ends with
What a run leaves behind	Every line a run prints, every key of report.json, the page report.html, and the stored run --store keeps
The faults RESTest reports	The kinds of fault a run reports, which are errors and which warnings, what each means, and how they are counted
The campaign file	The plan a run follows: where its values come from, how much of it pushes at the API, which operations it may touch
The dictionary format	Lists of values of your own, handed over with --dictionary
The JSON Schemas	The schemas of a dictionary and a plan: where they are, and how an editor, a validator or a language model uses them
The settings	Every number that says how the tool behaves, with its default, and the three ways to change one
The switches	The settings that turn one thing a run does off, what leaving each on costs, and files that turn off a whole idea
RESTest and coding agents	What to tell a coding agent so that it tests an API with RESTest, what it then does, and the skill that teaches it
Known limitations	What RESTest does not do yet, or does in a way that may surprise you, and what to do about it

Building RESTest

Page	What it covers
The rules	The design principles, the hard rules, the commands and where everything is; read by people and coding agents alike
Design	What the tool is, how it is put together, the rules the build enforces, and a glossary
Continuous integration	What every pull request is checked for, how to run the same checks locally, and how a release is made
Decision records	Why the tool is shaped the way it is, one decision per file
Contributing	How a change is proposed, built and reviewed