AutoMaxProjects and environments
How a project directory is laid out and how environments describe where tests run.
What lives in a project directory, how environment files describe targets, how Playwright projects are generated from them, and which commands create and inspect both.
A project is a directory
projects/demo-shop/
automax.project.yaml # identity, layers, browsers, tags, routes, data, auth, screenshots, heal, modules, processes
envs/staging.yaml # base URLs, API auth (${VAR}), pool size, locale, per-env overrides
envs/local.yaml
.env.staging # secrets (gitignored); .env.example documents the names
features/ # Gherkin, one folder per module (ui/, api/, hybrid/ or auth/, cart/ ...)
steps/fixtures.ts # extends the AutoMax test with your auth strategy and page objects
steps/*.steps.ts # project-specific steps
pages/*.ts # page objects with decorators
data/common/ data/staging/ data/factories.ts
recorded/ har/ .auth/The slug inside the YAML must equal the directory name; automax config validate checks it.
Environments
An environment is one target of the same application. Each has a file under envs/:
name: staging
ui:
baseUrl: https://www.saucedemo.com
api:
baseUrl: https://jsonplaceholder.typicode.com
headers: { Accept: application/json }
auth: { type: none } # or bearer/basic/header/oauth-client-credentials with ${VAR}
users:
poolSize: 4
vars:
defaultProduct: Sauce Labs Backpack
standardPassword: '${DEMO_SHOP_PASSWORD:-secret_sauce}'
use:
locale: en-US
timezoneId: America/New_York
screenshots: { onlyOnFailure: false } # overrides the project section for this envThe project lists which environments exist and which is the default:
envs:
default: staging
available: [local, staging]From YAML to Playwright projects
For each layer, features are generated once with bddgen; each browser is a Playwright project that reuses the generated files. The api project has no browser device. Run automax run -p demo-shop --list to print the names.
Commands
bun run automax project list
bun run automax env list -p demo-shop
bun run automax config show -p demo-shop -e staging --explainbun run automax project create billing --ui-url http://localhost:3000 --api-url http://localhost:3000/api --env local
bun run automax env add staging -p billing --ui-url https://billing-staging.example.com --api-url https://api-staging.example.comEvery environment must be listed in envs.available and have a file under envs/. automax doctor reports both kinds of mismatch.