GuideWhat is autoreg.md

What is autoreg.md?

autoreg.md describes your application to AutoReg: what it does, how to log in, which features to test, and which edge cases matter. It is the single input the AI agent needs to generate a complete E2E test suite.

Think of it as a test spec written for a very capable QA engineer who has never seen your app. Everything the agent knows about your application — URLs, credentials, selectors, expected behaviours — comes from this file plus what it observes in your running app.

autoreg.md is always generated, never written by hand. It’s produced by the generate-autoreg skill — see Generating autoreg.md — which installs in seconds into any repository, application, or project and writes the file for you.

How AutoReg uses it

  1. When you create a workflow (or run generation), the agent reads autoreg.md from your workflow folder.
  2. It enumerates every test scenario described or implied by the spec.
  3. For each scenario, it generates a tests/scenario-NNN.json test file with real selectors confirmed against your app.

Better spec in → better tests out. A detailed spec with credentials, exact button labels, and edge cases produces a suite that passes on the first run.

Where it lives

Place autoreg.md in your workflow folder — the same folder you select when creating a new AutoReg workflow. The agent reads it automatically when generation starts.

myworkflow/
├── autoreg.md          ← your spec
├── myworkflow.ar       ← manifest (auto-created)
├── tests/              ← generated test files
└── plans/              ← generated plan

You can also paste the spec into the New Workflow dialog — it is saved to disk as autoreg.md automatically.

What a spec contains

A generated autoreg.md typically covers:

  • App overview — what the app does and its base URL
  • Test credentials — one set per role the app supports
  • Features — the feature areas and behaviours to cover
  • Edge cases — validation errors, permission checks, and limits worth testing
  • UI notes — anything unusual the generator should know about, like custom components or multi-step flows

Keeping a spec current

If your app changes, re-run the generate-autoreg skill to refresh autoreg.md rather than editing the file directly. This keeps the spec accurate and lets AutoReg continue to recognize it as a genuine, up-to-date spec when you import it.

Next steps

InstallationGenerating autoreg.md