Skip to content

Test File Reference

Test files use TOML format with a .test.toml extension.

name = "Test name" # Required: identifies the test
[overrides.provider] # Optional: override provider settings
extra_system_prompt = "..."
step_timeout_secs = 600
base_url = "http://localhost:5000"
[[steps]] # At least one step required
instruction = "Plain English instruction"
step_timeout_secs = 300 # Optional: per-step timeout
skip = true # Optional: skip this step
checkpoint = "checkpoint-name" # Optional: save/restore state
[[steps]]
include_path = "path/to/file.test.toml" # Include another file's steps
[[steps]]
include_glob = "features/*.test.toml" # Include multiple files by glob
FieldTypeRequiredDescription
namestringyesTest name shown in console output and reports
FieldTypeDescription
extra_system_promptstringReplaces global extra_system_prompt
step_timeout_secsintegerReplaces global step timeout
base_urlstringReplaces global base URL

Each step must have exactly one of instruction, include_path, or include_glob.

FieldTypeRequiredDescription
instructionstringyes*Plain-English instruction sent to the agent
step_timeout_secsintegernoOverride timeout for this step
skipbooleannoSkip this step (counts as passed)
checkpointstringnoSave state after pass, restore if skipped
FieldTypeRequiredDescription
include_pathstringyes*Relative path to a test file to inline
include_globstringyes*Glob pattern to inline multiple files

Include steps are expanded into the flat step list before execution. Glob matches are sorted alphabetically.

PatternBehavior
*.test.tomlDiscovered by bugatti test
_*.test.tomlExcluded from discovery (include-only)