Workspace configuration

The directory where all your Maestro-related configuration lives is a Maestro workspace (or just workspace for short).

Maestro configuration

The following properties can be configured on the workspace as a whole as part of the workspace configuration.

  • flows: inclusion patterns regarding what Flows to include (docs). Optional.

  • includeTags: list of tags to include on each run (docs). Optional.

  • excludeTags: list of tags to exclude on each run (docs). Optional.

Example

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:

flows:
  - "subFolder/*"
includeTags:
  - tagNameToInclude
excludeTags:
  - tagNameToExclude

Maestro Cloud configuration

There are other workspace configuration options available that relate to Maestro Cloud which are not outlined here. Please refer to the Maestro Cloud documentation for more information.

Environment variables

Variable name
Description
Type
Default
Further reading

MAESTRO_API_URL

The URL of the Maestro API to use. Probably only useful to Mobile Inc developers.

String

https://api.mobile.dev

-

MAESTRO_CLI_AI_KEY

Key for external AI service used in AI operations.

String

-

MAESTRO_CLI_NO_ANALYTICS

Disables Maestro analytics collection

Boolean

false

-

MAESTRO_CLOUD_API_KEY

The API key to use when communicating with Maestro Cloud

String

-

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

Any other environment variables prefixed with MAESTRO_ will be available in your Flows as JavaScript variables. See Accessing variables from the shell for more information.

PreviousConfigurationNextFlow configuration

Last updated