Workspace configuration
Last updated
Was this helpful?
Last updated
Was this helpful?
The directory where all your Maestro-related configuration lives is a Maestro workspace (or just workspace for short).
The following properties can be configured on the workspace as a whole as part of the workspace configuration. All settings are optional.
flows: inclusion patterns regarding what Flows to include ().
includeTags: list of tags to include on each run ().
excludeTags: list of tags to exclude on each run ().
executionOrder: the order to run sequential tests before running remaining tests ().
baselineBranch: Which branch is your baseline. Useful when integrating with Pull Requests (). Cloud only.
notifications: Who to notify after an Upload finishes processing (). Cloud only. You might prefer the .
Below is an example Maestro workspace configuration file. Typically it's named config.yaml and placed in the .maestro directory in your project's root:
It's possible to have multiple config files in a repository and specify them at execution time. For example, the default config.yaml could cover the tests typically run on the main branch, but an additional pr-config.yaml might cover the flows and tags used when running tests on each Pull Request.
Any other environment variables prefixed with MAESTRO_ will be available in your Flows as JavaScript variables. See for more information.
MAESTRO_API_URL
The URL of the Maestro API to use. Probably only useful to Mobile Inc developers.
String
https://api.copilot.mobile.dev
-
MAESTRO_CLI_AI_KEY
Key for external AI service used in AI operations
String
-
MAESTRO_CLI_AI_MODEL
Model for external AI service used in AI operations. The prefix of the model decides which service to use. If none is specified, OpenAI will be used.
String
gpt-4o for OpenAI, claude-3-5-sonnet-20240620 for Claude
-
MAESTRO_CLI_ANALYSIS_NOTIFICATION_DISABLED
Disables the notification displayed on each run about AI analysis
Boolean
false
-
MAESTRO_CLI_LOG_PATTERN_CONSOLE
String
%highlight([%5level]) %msg%n
-
MAESTRO_CLI_LOG_PATTERN_FILE
String
%d{HH:mm:ss.SSS} [%5level] %logger.%method: %msg%n
MAESTRO_CLI_NO_ANALYTICS
Disables Maestro analytics collection
Boolean
false
-
MAESTRO_CLOUD_API_KEY
The API key to use when communicating with the Maestro cloud platform
String
-
MAESTRO_CLOUD_API_URL
Like MAESTRO_API_URLbut used for AI API requests
String
https://api.copilot.mobile.dev
-
MAESTRO_DISABLE_UPDATE_CHECK
Disable the check for newer Maestro versions when running the CLI
Boolean
false
-
MAESTRO_DRIVER_STARTUP_TIMEOUT
The maximum time to wait for a driver to start
Number
15000
MAESTRO_USE_GRAALJS
Use GraalJS instead of RhinoJS for JavaScript execution
Boolean
false
Sets the for logging in the console
Sets the for logging in the log file