VigilQA Docs

Config Reference

Complete reference for Knowledge Base YAML fields, project settings, agent configuration options, and the storage policy that governs artifact retention and backup behavior.

Knowledge Base YAML fields

Application block

FieldTypeRequiredDescription
app.namestringYesProject identifier slug (no spaces, lowercase)
app.base_urlURLYesBase URL of the application under test
app.typestringYesweb, api, or web+api
app.auth.typestringNobearer, api_key, basic, oauth2_client

Domain block

FieldTypeRequiredDescription
domainstringYesDomain identifier slug (used in scenario IDs and test file paths)
base_urlsstring[]NoList of URL paths this domain primarily covers. AppExplorer crawls these paths.

Scenario block

FieldTypeRequiredDescription
idstringYesUnique scenario identifier. Convention: DOMAIN-NNN
titlestringYesShort description of what is being tested
stepsstring[]YesOrdered list of user/API actions
expectedstringYesObservable outcome that confirms the test passes
modulestringNoOverride module: web_ui, api, api_contract, visual_regression, accessibility, security, performance
tagsstring[]NoLabels for test plan filtering
prioritystringNohigh, medium, or low
endpointstringNoAPI endpoint path (API module hint)
methodstringNoHTTP method (API module hint): GET, POST, PUT, DELETE, PATCH
max_response_msintegerNoPerformance threshold in milliseconds
auth_requiredbooleanNoWhether this scenario requires an authenticated session (default: true)
viewportstringNoVisual regression viewport: desktop, tablet, mobile

Project settings reference

All project settings are managed through the dashboard at Project → Settings. Key settings:

  • Modules — enable/disable test modules
  • Execution timeout — maximum run duration (default: 30 min)
  • Parallel workers — concurrent test execution threads (default: 4, max: 16 on Pro)
  • Flaky test quarantine — stability threshold below which tests are quarantined (default: 0.5)
  • Contract strictness — whether non-breaking additions trigger contract test alerts
  • Security scan target — which environment to run security tests against
  • Artifact retention — local and backup storage behavior for generated evidence and run artifacts