mirror of
https://github.com/tester-army/e2e.git
synced 2026-11-21 03:05:26 +08:00
* feat(notte): add @e2e-dev/notte, a browser provider for Notte cloud browsers notte() runs each test attempt in its own Notte cloud browser session and stops it when the attempt ends. It leases in attempt scope only: a Notte session refuses Target.createBrowserContext, which worker scope needs. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * feat(notte): downloads, sweep, and console links, verified on the testbed - downloads.read copies each download from the session's file storage, found by the site's suggested name. @e2e-dev/web now passes that name to providers as BrowserDownloadContext.suggestedFilename (optional, additive). - sweep stops the sessions of workers that died, found through per-session marker files under the system temp directory, since Notte sessions have no tags. - The progress line links the session's console page instead of the token-bearing viewer URL. - A start response without cdp_url falls back to the session's debug info. - apps/testbed gets e2e.notte.config.ts and test:notte. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * fix(notte): address review: fail-closed ledger, required suggestedFilename, paged downloads, shared sweep helper * docs(notte): add notte() to the security table and skill setup --------- Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com> Co-authored-by: Oskar Kwaśniewski <oskar@okwasniewski.com>
215 lines
15 KiB
Plaintext
215 lines
15 KiB
Plaintext
---
|
|
title: Environment variables
|
|
description: Every variable the runner and the first-party engines read, and what each one does.
|
|
"og:image": "https://e2e.com/docs/images/og/reference/environment.png?v=67a4d71e70"
|
|
"twitter:image": "https://e2e.com/docs/images/og/reference/environment.png?v=67a4d71e70"
|
|
---
|
|
|
|
These variables configure the runner and first-party packages. In the tables,
|
|
`set` means the variable exists, `value` means it is not blank, and `flag`
|
|
means it is not blank, `0`, or `false`. Flag values are case-insensitive.
|
|
|
|
```bash
|
|
export E2E_USER_ADMIN_PASSWORD="$ADMIN_PASSWORD"
|
|
export E2E_CACHE_DIR=~/.cache/e2e
|
|
export E2E_TELEMETRY_DISABLED=1
|
|
```
|
|
|
|
## Reference
|
|
|
|
### Model
|
|
|
|
Configure a model in `e2e.config.ts`. Its provider reads the API key:
|
|
`gateway()` uses `AI_GATEWAY_API_KEY`, `openrouter()` uses
|
|
`OPENROUTER_API_KEY`, and `openai()` uses `OPENAI_API_KEY`. Without
|
|
`AI_GATEWAY_API_KEY`, `gateway()` uses a
|
|
[Vercel OIDC token](/models#vercel-oidc-instead-of-a-key). A missing
|
|
credential fails on the first model call. Subscription models use a stored
|
|
login instead.
|
|
See [Models](/models) and [Subscriptions](/subscriptions).
|
|
|
|
| Variable | Example | Reading | Effect |
|
|
| --- | --- | --- | --- |
|
|
| [`E2E_OAUTH_CREDENTIALS`](#e2e_oauth_credentials) | `E2E_OAUTH_CREDENTIALS="$(cat oauth.json)"` | value | The stored subscription logins as JSON |
|
|
| [`OPENCODE_API_KEY`](#opencode_api_key) | `OPENCODE_API_KEY=<key>` | value | Replaces the stored `opencode-console` login |
|
|
| `XDG_CONFIG_HOME` | `XDG_CONFIG_HOME=~/.config` | value | Directory of the stored logins, `$XDG_CONFIG_HOME/e2e/oauth.json`; default `~/.config/e2e/oauth.json` |
|
|
|
|
#### `E2E_OAUTH_CREDENTIALS`
|
|
|
|
The stored subscription logins as JSON, the contents of `oauth.json`, for a
|
|
machine nobody can sign in on.
|
|
|
|
- The `e2e/oauth/*` models and `e2e models` read it in place of
|
|
`$XDG_CONFIG_HOME/e2e/oauth.json`.
|
|
- `e2e login` and `e2e logout` refuse to change it.
|
|
- Refreshed tokens are not written back.
|
|
|
|
#### `OPENCODE_API_KEY`
|
|
|
|
An OpenCode Console service account API key or an OpenCode Go subscription
|
|
API key. `opencodeConsole()` and `e2e models opencode-console` use it in place
|
|
of the stored `opencode-console` login. OpenCode reads the same variable.
|
|
|
|
### Credentials and secrets
|
|
|
|
| Variable | Example | Reading | Effect |
|
|
| --- | --- | --- | --- |
|
|
| `E2E_USER_<NAME>_USERNAME` | `E2E_USER_ADMIN_USERNAME=admin@example.test` | set | Replaces `credentials.<name>.username` |
|
|
| `E2E_USER_<NAME>_PASSWORD` | `E2E_USER_ADMIN_PASSWORD="$ADMIN_PASSWORD"` | set | Replaces `credentials.<name>.password` |
|
|
| `E2E_SECRET_<NAME>` | `E2E_SECRET_API_KEY="$API_KEY"` | set | Replaces the value of `secrets.<name>` |
|
|
|
|
- `<NAME>` is the name uppercased with every character outside `A-Z0-9`
|
|
replaced by `_`, so `power-user` becomes `E2E_USER_POWER_USER_USERNAME`.
|
|
- Two credentials, or two secrets, whose names map to one `<NAME>` are
|
|
`INVALID_CONFIG` at config load, set or not. So one rotation never
|
|
replaces two entries. The message names the entries and the variables.
|
|
For example, `api-key` and `api_key` both read `E2E_SECRET_API_KEY`;
|
|
`svc-a` and `svc_a` both read `E2E_USER_SVC_A_USERNAME` and `_PASSWORD`.
|
|
- A credential and a secret may share a name, since their prefixes differ.
|
|
- A variable for a name absent from the config is ignored.
|
|
- An empty password or secret is `INVALID_CONFIG`, and so is one shorter
|
|
than 6 characters (code points). Redaction rewrites every occurrence of a
|
|
value, and one that short would take ordinary text with it. An empty
|
|
username is accepted.
|
|
|
|
### Run mode
|
|
|
|
| Variable | Example | Reading | Effect |
|
|
| --- | --- | --- | --- |
|
|
| [`CI`](#ci) | `CI=1` | flag | CI mode |
|
|
|
|
#### `CI`
|
|
|
|
Turns on CI mode:
|
|
|
|
- `retries` defaults to 1 and `workers` to 1.
|
|
- `cache` defaults to `read-only`.
|
|
- A focused test is `ONLY_IN_CI`.
|
|
- `reuseExisting` on an app command is ignored.
|
|
|
|
### Replay cache
|
|
|
|
| Variable | Example | Reading | Effect |
|
|
| --- | --- | --- | --- |
|
|
| [`E2E_CACHE_DIR`](#e2e_cache_dir) | `E2E_CACHE_DIR=~/.cache/e2e` | value | Replaces [`cache.dir`](/reference/config#cache) |
|
|
|
|
#### `E2E_CACHE_DIR`
|
|
|
|
Replaces [`cache.dir`](/reference/config#cache) for `e2e run` and
|
|
`e2e cache`, resolved from the project root.
|
|
|
|
- `~` or a leading `~/` is the home directory.
|
|
- `--cache-dir` wins over it.
|
|
- A custom `cache.store` ignores it.
|
|
- The cache mode stays as configured, and `--no-cache` still turns the cache
|
|
off.
|
|
|
|
### Diagnostics
|
|
|
|
| Variable | Example | Reading | Effect |
|
|
| --- | --- | --- | --- |
|
|
| `NO_COLOR` | `NO_COLOR=1` | set | Plain CLI output. Without it, colors are on for a TTY or in CI, off when piped |
|
|
| `FORCE_COLOR` | `FORCE_COLOR=1` | set | Colored CLI output even when piped |
|
|
| `TERM` | `TERM=dumb` | value | `dumb` draws the `e2e init` logo at rest, without animation, as in CI |
|
|
| `GITHUB_SHA`, `GITHUB_HEAD_REF`, `GITHUB_REF_NAME` | `GITHUB_REF_NAME=main` | value | The commit and branch the report records under `run.vcs` when `git` cannot read the project root. `GITHUB_HEAD_REF` wins over `GITHUB_REF_NAME` |
|
|
|
|
`--debug` and `--ai-trace` are flags, not variables; see
|
|
[CLI](/reference/cli#e2e-run).
|
|
|
|
### Telemetry
|
|
|
|
| Variable | Example | Reading | Effect |
|
|
| --- | --- | --- | --- |
|
|
| `E2E_TELEMETRY_DISABLED` | `E2E_TELEMETRY_DISABLED=1` | flag | Turns anonymous usage telemetry and the [update check](/reference/cli#help-and-version) off. `e2e telemetry disable` saves the same choice for telemetry in the preferences file |
|
|
| `DO_NOT_TRACK` | `DO_NOT_TRACK=1` | flag | Same as `E2E_TELEMETRY_DISABLED` |
|
|
| `E2E_UPDATE_CHECK_DISABLED` | `E2E_UPDATE_CHECK_DISABLED=1` | flag | Turns the daily check for a newer e2e release off |
|
|
| `NO_UPDATE_NOTIFIER` | `NO_UPDATE_NOTIFIER=1` | flag | Same as `E2E_UPDATE_CHECK_DISABLED` |
|
|
| `npm_config_registry` | `npm_config_registry=https://npm.example.com/` | value | The registry [`e2e upgrade`](/reference/cli#e2e-upgrade) reads versions from; default `https://registry.npmjs.org/`. Package managers set it for the commands they run |
|
|
| `E2E_TELEMETRY_DEBUG` | `E2E_TELEMETRY_DEBUG=1` | flag | Prints every telemetry event to stderr instead of sending it |
|
|
| [`E2E_TELEMETRY_FLEET`](#e2e_telemetry_fleet) | `E2E_TELEMETRY_FLEET=acme` | value | Names the platform running e2e for its users |
|
|
| `XDG_CONFIG_HOME` | `XDG_CONFIG_HOME=~/.config` | value | Directory of the preferences file and the update check's `update-check.json`, `$XDG_CONFIG_HOME/e2e`; default `~/.config/e2e` |
|
|
| `APPDATA` | `APPDATA=C:\Users\ada\AppData\Roaming` | value | The same on Windows, `%APPDATA%\e2e`; default `~/AppData/Roaming/e2e` |
|
|
|
|
#### `E2E_TELEMETRY_FLEET`
|
|
|
|
Names the platform running e2e for its users.
|
|
|
|
- Events are attributed to `fleet:<name>` instead of a per-machine id.
|
|
- No preferences file is written, and no notice is printed.
|
|
- A value that is not a plain token is sent as `other`.
|
|
|
|
#### Detected environments
|
|
|
|
Telemetry also checks for the markers CI vendors and coding agents set. Only
|
|
the derived name is sent.
|
|
|
|
| Markers | Reported as |
|
|
| --- | --- |
|
|
| `GITHUB_ACTIONS`, `GITLAB_CI`, `CIRCLECI`, `BUILDKITE`, `JENKINS_URL`, `TRAVIS`, `BITBUCKET_BUILD_NUMBER`, `TF_BUILD`, `TEAMCITY_VERSION`, `CODEBUILD_BUILD_ID`, `VERCEL`, `NETLIFY`, `DRONE`, `SEMAPHORE`, `APPVEYOR`, `WOODPECKER`, `EAS_BUILD`, `BITRISE_IO`, `CM_BUILD_ID`, `CI_XCODE_CLOUD` | `ci_name`: `github-actions`, `gitlab`, `circleci`, `buildkite`, `jenkins`, `travis`, `bitbucket`, `azure-pipelines`, `teamcity`, `aws-codebuild`, `vercel`, `netlify`, `drone`, `semaphore`, `appveyor`, `woodpecker`, `eas`, `bitrise`, `codemagic`, `xcode-cloud`; `unknown` when only `CI` is set |
|
|
| `CLAUDECODE`, `CLAUDE_CODE`, `CURSOR_AGENT`, `CURSOR_TRACE_ID`, `CODEX_SANDBOX`, `CODEX_THREAD_ID`, `CODEX_CI`, `GEMINI_CLI`, `COPILOT_GITHUB_TOKEN`, `COPILOT_MODEL`, `COPILOT_ALLOW_ALL`, `OPENCODE_CLIENT`, `AUGMENT_AGENT`, `ANTIGRAVITY_AGENT`, `REPL_ID`, `AI_AGENT` | `coding_agent`: `claude-code`, `cursor`, `codex`, `gemini-cli`, `copilot`, `opencode`, `augment`, `antigravity`, `replit`, `other` |
|
|
| `WSL_DISTRO_NAME` | `wsl: true` |
|
|
| `npm_config_user_agent` | `package_manager`: the invoking package manager. `e2e init` reads the same variable to pick the install command |
|
|
|
|
What is sent and how to read it is on the [Telemetry](/telemetry) page.
|
|
|
|
### Reporters
|
|
|
|
`@e2e-dev/github` reads the variables GitHub Actions sets, when a run finishes:
|
|
|
|
| Variable | Example | Reading | Effect |
|
|
| --- | --- | --- | --- |
|
|
| `GITHUB_ACTIONS` | `GITHUB_ACTIONS=true` | value | Without it the reporter posts nothing and says so |
|
|
| `GITHUB_REPOSITORY`, `GITHUB_RUN_ID`, `GITHUB_EVENT_NAME`, `GITHUB_WORKFLOW`, `GITHUB_JOB` | `GITHUB_REPOSITORY=acme/shop` | value | Always set by the runner. A missing one fails the reporter, naming the variable. The repository and run id build the artifacts link. The event name shows in the "not a pull request" row. The workflow and job join the marker a rerun finds its own comment by |
|
|
| `GITHUB_TOKEN`, `GH_TOKEN` | `GITHUB_TOKEN=<token>` | value | Posts the comment; the first one set wins. Unset, the job summary is still written. A fork's `pull_request` token is read-only and cannot post; see [When nothing is posted](/github#when-nothing-is-posted) |
|
|
| `GITHUB_EVENT_PATH`, `GITHUB_REF` | `GITHUB_REF=refs/pull/42/merge` | value | The pull request number and head commit from the event payload, or the number from `refs/pull/N/merge` |
|
|
| `GITHUB_SHA` | `GITHUB_SHA=<commit>` | value | The commit source links point at when the event is not about a pull request |
|
|
| `GITHUB_WORKSPACE` | `GITHUB_WORKSPACE=/home/runner/work/shop/shop` | value | The checkout root. Source links add the project's path inside it, so a suite in a subdirectory links to the right file |
|
|
| `GITHUB_SERVER_URL`, `GITHUB_API_URL` | `GITHUB_SERVER_URL=https://github.example.com` | value | The GitHub host, for Enterprise Server. Default `https://github.com` and `https://api.github.com` |
|
|
| `GITHUB_STEP_SUMMARY` | `GITHUB_STEP_SUMMARY=<file>` | value | The job summary file the comment text is appended to |
|
|
|
|
### Engines
|
|
|
|
| Variable | Example | Reading | Effect |
|
|
| --- | --- | --- | --- |
|
|
| `PLAYWRIGHT_BROWSERS_PATH` | `PLAYWRIGHT_BROWSERS_PATH=~/.cache/ms-playwright` | value | Playwright's browser cache, honored by the engine's `prepare` hook |
|
|
| `PLAYWRIGHT_SKIP_BROWSER_GC` | `PLAYWRIGHT_SKIP_BROWSER_GC=0` | value | Defaults to `1` for the engine's browser install, which keeps other browsers in the cache. `0` lets the install remove them |
|
|
| `KERNEL_API_KEY` | `KERNEL_API_KEY=<key>` | value | The API key `kernel()` from `@e2e-dev/kernel` creates browsers with. Unset, the browser lease fails. See [Kernel](/integrations/kernel) |
|
|
| `NOTTE_API_KEY` | `NOTTE_API_KEY=<key>` | value | The API key `notte()` from `@e2e-dev/notte` starts sessions with. Unset, the browser lease fails. See [Notte](/integrations/notte) |
|
|
| `NOTTE_API_URL` | `NOTTE_API_URL=<url>` | value | The Notte API URL `notte()` calls. Default `https://api.notte.cc` |
|
|
| `LIGHTPANDA_PATH` | `LIGHTPANDA_PATH=/opt/lightpanda` | value | The binary `lightpanda()` from `@e2e-dev/lightpanda` starts a CDP server with. Unset, `lightpanda` on `PATH`, `~/.lightpanda`, or `~/.local/bin`. See [Lightpanda](/integrations/lightpanda) |
|
|
| `MOLI_PATH` | `MOLI_PATH=/opt/moli` | value | The executable `moli()` from `@e2e-dev/moli` starts when `binary` is unset. Without `MOLI_PATH`, it searches `PATH`, then `~/.local/bin/moli`. See [Moli](/integrations/moli) |
|
|
| [`EXPO_TOKEN`](#expo_token) | `EXPO_TOKEN=<token>` | value | The Expo access token `expoSimulators()` from `@e2e-dev/eas` uses |
|
|
| `HOME`, `USERPROFILE` | `HOME=/home/ada` | value | Where `expoSimulators()` finds the eas-cli login without `EXPO_TOKEN`: `USERPROFILE` on Windows, `HOME` elsewhere, the OS user's home when unset |
|
|
| `LIMRUN_API_KEY` | `LIMRUN_API_KEY=<key>` | value | The API key `limrun()` from `@e2e-dev/limrun` leases devices with. Unset, the lease fails with `INVALID_CONFIG`. See [Limrun](/integrations/limrun) |
|
|
| `LIMRUN_BASE_URL` | `LIMRUN_BASE_URL=<url>` | value | The Limrun API host. Default `https://api.limrun.com` |
|
|
| `BROWSERSTACK_USERNAME`, `BROWSERSTACK_ACCESS_KEY` | `BROWSERSTACK_USERNAME=acme_AbC123` | value | The BrowserStack username and access key `browserstack()` from `@e2e-dev/browserstack` leases devices with. With either unset, the device lease fails. See [BrowserStack](/integrations/browserstack) |
|
|
| `BROWSERSTACK_API_ENDPOINT` | `BROWSERSTACK_API_ENDPOINT=<url>` | value | The App Automate API base URL `browserstack()` uploads `https` builds to and looks up session recordings at. Default `https://api-cloud.browserstack.com/app-automate`. A value that is not an http(s) URL, or carries a username or password, fails with `INVALID_CONFIG` |
|
|
| `LT_USERNAME`, `LT_ACCESS_KEY` | `LT_USERNAME=acme` | value | The TestMu AI username and access key `testmu()` from `@e2e-dev/testmu` leases devices with. With either unset, the device lease fails. `testmuBrowsers()` from `@e2e-dev/testmu/web` puts them only in the CDP URL of each browser session, and with either unset the browser lease fails. See [TestMu AI](/integrations/testmu) |
|
|
| `TESTMU_API_ENDPOINT` | `TESTMU_API_ENDPOINT=<url>` | value | The TestMu AI sessions API base URL `testmu()` looks up session recordings at. Default `https://mobile-api.lambdatest.com/mobile-automation/api/v1`. A value that is not an http(s) URL, or carries a username or password, fails the lookup with `INVALID_CONFIG`. agent-device's TestMu AI plugin reads it too |
|
|
| `REVYL_API_KEY` | `REVYL_API_KEY=<key>` | value | The API key `revyl()` from `@e2e-dev/revyl` leases devices with. Unset, the device lease fails. See [Revyl](/integrations/revyl) |
|
|
| `REVYL_API_URL` | `REVYL_API_URL=<url>` | value | The Revyl backend `revyl()` leases devices from. Default `https://backend.revyl.ai`. agent-device's Revyl plugin reads it |
|
|
| `E2B_API_KEY` | `E2B_API_KEY=<key>` | value | The API key `e2b()` from `@e2e-dev/e2b` and `e2bBrowsers()` from `@e2e-dev/e2b/web` create sandboxes with. Unset, the lease fails with `INVALID_CONFIG`. See [E2B](/integrations/e2b) |
|
|
| `E2B_DOMAIN` | `E2B_DOMAIN=e2b.example.com` | value | The E2B domain the providers create sandboxes on. Default `e2b.app`. Set it for a dedicated E2B cluster |
|
|
| `E2B_API_URL` | `E2B_API_URL=<url>` | value | The E2B API URL the providers call. Default `https://api.<E2B_DOMAIN>` |
|
|
| `E2B_SANDBOX_URL` | `E2B_SANDBOX_URL=<url>` | value | The URL the providers send sandbox commands and uploads to. Default: the E2B SDK builds it from `E2B_DOMAIN`. If the shell that starts e2e sets it, the run's environment must set the same value, or the lease fails with `INVALID_CONFIG` |
|
|
| `E2E_WEB_BROWSERS_<TARGET>_<digest>` | - | value | `@e2e-dev/web` writes it in `prepare`; each worker reads it to find its leased browser. Don't set it by hand |
|
|
| `E2E_AGENT_DEVICE_POOL_<TARGET>_<digest>` | - | value | `@e2e-dev/mobile` writes it in `prepare`; each worker reads it to find its booted device. Don't set it by hand |
|
|
|
|
#### `EXPO_TOKEN`
|
|
|
|
The Expo access token `expoSimulators()` from `@e2e-dev/eas` starts and stops
|
|
simulator sessions with. See [Expo Simulators](/integrations/eas).
|
|
|
|
- Unset, it uses the eas-cli login in `.expo/state.json` under the home
|
|
directory ([`HOME`, `USERPROFILE`](#engines)).
|
|
- With neither, the device lease fails.
|
|
|
|
## What app processes inherit
|
|
|
|
An app `command` receives `PATH`, `HOME`, `TMPDIR`, `TMP`, `TEMP`,
|
|
`SystemRoot`, and `COMSPEC`, plus the variables `command.inheritEnv` matches
|
|
and whatever `command.env` sets.
|
|
|
|
The scaffolded config module reads `APP_URL`, not the runner. If the dev
|
|
server needs it too, pass it through `command.env`.
|