Skip to main content

Environment variables

Overview​

Use env vars to inject secrets (API keys), toggle behavior per environment, or parameterize CI without editing files. They override config file values.

This page mentions some common variables, but note that most config keys also have an env form: e.g., navigationWaitUntil → APPLITOOLS_NAVIGATION_WAIT_UNTIL. (Pattern: APPLITOOLS_<UPPER_SNAKE_CASE> for most config keys).

Common variables (with context & examples)​

  • APPLITOOLS_API_KEY — required. Your Eyes API key.

    export APPLITOOLS_API_KEY="…"

  • APPLITOOLS_SERVER_URL — Set for private cloud. Defaults to the public cloud.

  • APPLITOOLS_APP_NAME — Override the application name used for baselines (helpful in mono‑repos).

  • APPLITOOLS_SHOW_LOGS — true|false. Verbose SDK logs when troubleshooting.

  • APPLITOOLS_BATCH_ID — A unique identifier for grouping tests into a batch.

  • APPLITOOLS_BATCH_NAME — Batch display name:

    export APPLITOOLS_BATCH_NAME="PR #1234 — Buttons refactor"

  • APPLITOOLS_BATCH_SEQUENCE_NAME — Optional sequence name for batch order/reporting.

  • APPLITOOLS_PROXY — Proxy URL or object (URL, username, password, isHttpOnly).

  • APPLITOOLS_NOTIFY_ON_COMPLETION — true|false. Send batch completion notifications.

  • APPLITOOLS_CONCURRENT_TABS — Default 3. Number of browser tabs to run concurrently (use with care; consumes resources).