Settings guide: what every setting does
Open Settings in the Studio and every option is explained right under its name. This page lists the same words in one place, so you can read ahead, search them, or ask an AI assistant to walk you through them.
Last updated:
How Settings works
- Change, then save. Edit what you need and press Save changes. A dot beside a setting means it is changed but not saved yet.
- Most people change very little. Every setting has a sensible default. If you are unsure, leave it alone.
- Secrets stay on your computer. Passwords, tokens and keys are saved in your workspace's
.envfile and are shown as dots. Nothing is sent to us. - The name in grey is the setting's file name. It is the line in
.env, in case you set it from a pipeline or a script.
Security & Auth
Login for API tests.
| Setting | What it does | Default |
|---|---|---|
API token or passwordAPI_AUTH_TOKEN | The secret your API checks, from your API provider's account page; for Basic, type user:password. Empty means no login; reports show only its first 4 characters. | Empty. Saved only on this computer. |
API login methodAPI_AUTH_TYPE | How your API checks who is calling: Bearer sends a token, Basic a username and password, ApiKey a key in a header. Default is Bearer. | Bearer |
API key header nameAPI_AUTH_HEADER | Only for ApiKey: the name of the header that carries your key, such as api-key. Leave it empty to use X-Api-Key. | Empty |
Smart Monkey
Extra API safety checks while exploring.
| Setting | What it does | Default |
|---|---|---|
Passive API safety checkNEXUS_API_AUDIT | While exploring, it reads the API replies your app already gets and flags weak spots like leaked data, sending nothing extra. Off by default; use only on apps you may test. | false |
Login-bypass checkNEXUS_API_ACTIVE | Repeats the data requests your app made with a login token, without it, to see if the server still answers. Read-only but sends extra requests; off by default. | false |
Targets & API
API addresses, speed limits and saved proof.
| Setting | What it does | Default |
|---|---|---|
API main addressAPI_BASE_URL | The address that API tests with only a path (like /users) start from, e.g. https://api.example.com. Leave empty: a value here also redirects every recorded API test to it. | Empty |
GraphQL addressAPI_GRAPHQL_URL | The address of your GraphQL service (an API where you ask for exactly the data you want). If empty, the built-in GraphQL examples query a public demo service, not yours. | Empty |
Slowest allowed replyNEXUS_API_LATENCY_BUDGET | Longest an API reply may take, in milliseconds (1000 = 1 second); slower replies are flagged as slow. Default is 2000 (2 seconds). | 2000 |
Timing repeats per requestNEXUS_API_SAMPLES | How many times each API request is sent to measure speed reliably (1 to 200); only the first reply is checked. Default is 20; lower it if repeats bother your server. | 20 |
Repeat data-changing requestsNEXUS_API_SAMPLE_WRITES | Also repeats requests that create or change data (POST, PUT, PATCH, DELETE). Off by default, because 20 repeats would create 20 records on your server. | false |
Fail on changed repliesNEXUS_API_DRIFT_STRICT | A reply that gains a field or changes a data type is always reported as drifted. Turn on to also fail the test; off (default) only reports it. | false |
Passing API runs keptNEXUS_API_EVIDENCE_KEEP | How many passing runs of each API test keep their saved proof; older ones are deleted, failed runs never. Default is 20; 0 keeps every run. | 20 |
Largest saved reply sizeNEXUS_API_BODY_MAX_KB | Biggest request or reply body saved in the proof files, in KB; a larger one is cut off and saved with its full size and a fingerprint. Default is 256 KB. | 256 |
Fail on slow repliesNEXUS_API_PERF_STRICT | Turn on to fail an API test when a reply is slower than the allowed time above. Off (default): a slow reply only adds a warning. | false |
Check API safety headersNEXUS_API_SECURITY_HEADERS | Checks that API replies carry the standard protective headers (for example Content-Security-Policy); missing ones are noted as advice and never fail a test alone. On by default. | true |
App under test
Start your app automatically before runs.
| Setting | What it does | Default |
|---|---|---|
Command that starts your appNEXUS_APP_START | Launches your app before each run and stops it after, e.g. npm run dev; empty = you start it yourself. One command only: put chains like && in a package.json script. | Empty |
App folderNEXUS_APP_CWD | Full path of the folder your app starts from, where its package.json is; empty uses this workspace folder. On a remote machine, it is a folder on that machine. | Empty |
Address that means readyNEXUS_APP_READY_URL | The web address checked every half second to know your app has started; any answer except a server error counts. Empty uses your main test address (BASE_URL). | Empty |
Start-up wait limitNEXUS_APP_TIMEOUT_MS | How long to wait for your app to be ready, in milliseconds (1000 = 1 second); if it takes longer, the run does not start. Default is 120000 (2 minutes). | 120000 |
Reuse a running appNEXUS_APP_REUSE | On: if your app already answers at the ready address, it is used and left running; off: the run stops with an error so you never test something else by mistake. Default is on. | true |
Execution & Timeouts
How many tests run and how long to wait.
| Setting | What it does | Default |
|---|---|---|
Browsers per testNEXUS_PARALLEL_BROWSERS | How many browsers run one test at the same time, 1 to 3; default 1 is safest, 2 needs about 8 GB of memory and 3 about 16 GB. A run pinned to one browser always uses one. | 1 |
Tests at onceNEXUS_PARALLEL_TCS | How many tests run side by side in a full run, 1 to 32; default is 1 (one after another). Each extra test needs about 0.5 GB of memory per browser, so raise it only on a strong PC. | 1 |
Retry failed testsNEXUS_RETRY_ENABLED | A failed test runs once more before it is reported, which filters out one-time glitches. Turn off to see every failure at once; default is on. | true |
Time limit per testNEXUS_TC_TIMEOUT | Longest one test may run, in seconds, before it is force-stopped. Default is 360 (6 minutes); the test itself stops 1 minute earlier so it can save its evidence. | 360 |
Wait time for checksNEXUS_EXPECT_TIMEOUT | How long a check (like "this text appears") waits to come true, in milliseconds (1000 = 1 second); raising it helps slow pages without hiding bugs. Default is 10000 (10 seconds). | 10000 |
Wait per click or typingNEXUS_ACTION_TIMEOUT | How long a step like a click or typing waits for its target to be ready, in milliseconds (1000 = 1 second). Raise it for slow pages; default is 30000 (30 seconds). | 30000 |
Page opening time limitNEXUS_NAV_TIMEOUT | How long opening a page may take before the step fails, in milliseconds (1000 = 1 second). Default is 60000 (1 minute); raise it for very slow sites. | 60000 |
Wait after page opensNEXUS_LOAD_WAIT_MS | After a page opens, waits up to this many milliseconds (1000 = 1 second) for it to finish loading so clicks do not come too early. It never fails a test; 0 skips it, default is 8000. | 8000 |
Fail on missing safety headersNEXUS_SECURITY_STRICT | Turn on to fail a test when your app's pages lack protective headers (like Content-Security-Policy). Off (default) only notes it in the report; on an older app, this can fail every test. | false |
Firefox locationNEXUS_FIREFOX_BINARY | Full path to firefox.exe, used only by Selenium tests; empty = look in the usual places. A wrong path counts as no Firefox, so those Selenium tests are skipped. | Empty |
Tests that fail on purposeNEXUS_FIXTURE_TCS | IDs of tests written to fail on purpose, separated by commas. They stay out of the Risk Ranking unless you ask for them; empty by default. | Empty |
Selectors & Self-healing
Fragile-selector detection and repair.
| Setting | What it does | Default |
|---|---|---|
Fragile step warningsNEXUS_SMART_SELECTORS | When a test is recorded or imported, Suggest adds a comment above each step that finds things in a fragile way; Off adds none. Tests already written are not changed; default is Suggest. | suggest |
Auto-repair suggestionsNEXUS_SELF_HEAL | After a failure, prepares fixes in a background browser (skipped when RAM is low or a run is going). Suggest shows them, Verify also tests them in 3 browsers, Off does nothing. | suggest |
MLOps & Prediction
Forecast which tests are unreliable.
| Setting | What it does | Default |
|---|---|---|
Update unreliable-test forecastNEXUS_AUTO_PREDICT | After each run, updates the forecast of which tests are unreliable (sometimes pass, sometimes fail) so the Risk Ranking stays current. On by default. | true |
Accessibility
WCAG audit via axe-core.
| Setting | What it does | Default |
|---|---|---|
Check accessibilityNEXUS_A11Y_ENABLED | Scans pages for barriers that block people with disabilities, like low contrast or missing labels. Off by default; it needs the @axe-core/playwright add-on, and without it the scan is skipped. | false |
Accessibility rulebookNEXUS_A11Y_STANDARD | Picks the accessibility rulebook (WCAG) for the scan: version 2.0, 2.1 or 2.2, at level A (basic) or AA (standard). The default, 2.1 AA, is the usual legal baseline in Europe. | wcag21aa |
Minimum problem severityNEXUS_A11Y_FAIL_LEVEL | How severe a problem must be (minor, moderate, serious, critical) to count as a violation. Default is serious; it only matters if 'Fail the test on a violation' is on. | serious |
Fail test on violationNEXUS_A11Y_STRICT | When on, a test that finds a problem at or above the minimum severity is marked as failed (A11Y_VIOLATION). Off by default: problems are only listed in the report. | false |
Performance
Core Web Vitals budgets.
| Setting | What it does | Default |
|---|---|---|
Measure page speedNEXUS_PERF_ENABLED | Measures how fast each page loads and reacts (Core Web Vitals) and compares it to the limits below. On by default; it only adds data and never fails a test unless 'Fail on slow pages' is on. | true |
Main content load limitNEXUS_PERF_LCP | Longest time, in milliseconds (1000 = 1 second), for the main content of a page to appear. Default is 2500 (2.5 seconds), Google's 'good' mark; raise it for slow sites. | 2500 |
First content load limitNEXUS_PERF_FCP | Longest time, in milliseconds (1000 = 1 second), before the page shows its first text or image. Default is 1800 (1.8 seconds), Google's 'good' mark; raise it for slow sites. | 1800 |
Page jumping limitNEXUS_PERF_CLS | How much the page may jump around while loading, as a score where 0 means perfectly steady. Default is 0.1, Google's 'good' mark; a lower number is stricter. | 0.1 |
Page element limitNEXUS_PERF_DOM | Most elements (buttons, text blocks, images) a page may have before it is flagged as heavy for slow devices. Default is 1500. | 1500 |
Page memory limitNEXUS_PERF_HEAP | Most memory, in MB, a page's scripts may use before the page is flagged. Default is 50 MB; it is measured only in Chromium-based browsers such as Chrome and Edge. | 50 |
Click response limitNEXUS_PERF_INP | Longest time, in milliseconds (1000 = 1 second), a page may take to react after a click or tap. Default is 200, Google's 'good' mark; raise it for slow sites. | 200 |
Page freeze limitNEXUS_PERF_TBT | Most time, in milliseconds (1000 = 1 second), a page may stay frozen and ignore clicks while loading. Default is 200, the 'good' mark of Lighthouse (Google's audit tool). | 200 |
Server response limitNEXUS_PERF_TTFB | Longest time, in milliseconds (1000 = 1 second), for the server to start sending the page. Default is 800; slow results usually point to the server, not the page design. | 800 |
Slowdown toleranceNEXUS_PERF_TOLERANCE | How much slower than its own past results a page may get before the Evidence Locker flags a regression. Default 1.25 means 25% slower; values of 1 or less fall back to 1.25. | 1.25 |
Fail on slow pagesNEXUS_PERF_STRICT | When on, a page that goes over any speed limit above marks the test as failed (PERFORMANCE_DEGRADED). Off by default: slow pages are only recorded in the report. | false |
Check image loadingNEXUS_LAZY_ENABLED | Checks that images load in a way that keeps pages fast, for example the main image not being delayed. On by default, needs speed measuring on, and gives a 0 to 100 score without failing tests. | true |
First-load image limitNEXUS_LAZY_MAX_INITIAL_IMG_KB | Most image data, in KB (1000 KB is about 1 MB), a page may download when it first opens before the check flags it. Default is 1000 KB. | 1000 |
Fail on image problemsNEXUS_LAZY_STRICT | When on, a test is marked failed (PERFORMANCE_DEGRADED) if the main image is deliberately delayed or first-load images exceed the limit above. Off by default: it only reports. | false |
Load testing
Limits for traffic stress tests.
| Setting | What it does | Default |
|---|---|---|
Response time limitNEXUS_LOAD_P95 | In a load run, 95% of requests must finish within this many milliseconds (1000 = 1 second). Empty means no limit, so the result reads 'not evaluated'; a scenario's own limit wins. | Empty |
Allowed error percentageNEXUS_LOAD_ERROR_RATE | Most failed requests a load run may have, as a percent from 0 to 100 (5 means 5 of every 100 may fail). Empty means no limit; a scenario's own limit wins over this. | Empty |
Fail run on limit missNEXUS_LOAD_STRICT | When on, a load run that goes over its response time or error limit ends as failed, which stops automated builds. Off by default: the result is only reported. | false |
Load worker countNEXUS_LOAD_POOL | How many background workers create the traffic in a load run. Empty uses one per processor core, never more than the simulated users; each one costs roughly 80 MB on Windows. | Empty |
Hardware & Pacing
Slow tests down on low-memory computers.
| Setting | What it does | Default |
|---|---|---|
Pace tests by free RAMNEXUS_HW_MONITOR_ENABLED | When on, the app waits longer between tests, and runs fewer at once, when free RAM is low. Off by default (a fixed wait); turn it on for small or busy computers. | false |
Wait between testsNEXUS_HW_FIXED_PAUSE_MS | Wait between tests in multi-test runs, in milliseconds (1000 = 1 second), while RAM pacing is off. Default is 2000 (2 seconds); a single-test run never waits. | 2000 |
Tiny PC RAM limitNEXUS_HW_CRITICAL_GB | Computers with less total RAM than this, in GB, count as very small and wait longest between tests. Default is 4; used only when RAM pacing is on. | 4 |
Small PC RAM limitNEXUS_HW_LIMITED_GB | Computers with less total RAM than this, in GB, count as small. Default is 8; used only when RAM pacing is on, and it must be higher than the tiny limit. | 8 |
Standard PC RAM limitNEXUS_HW_NORMAL_GB | Computers with less total RAM than this, in GB, count as standard; above it they count as powerful and wait least. Default is 16; used only when RAM pacing is on. | 16 |
Wait when RAM is plentifulNEXUS_PAUSE_LOW_MS | Wait between tests, in milliseconds (1000 = 1 second), when most RAM is free. 0 (default) uses a built-in 1 to 3 seconds by PC size, not no wait; used only with RAM pacing on. | 0 |
Wait at moderate RAM useNEXUS_PAUSE_MEDIUM_MS | Wait between tests, in milliseconds (1000 = 1 second), when RAM use is moderate. 0 (default) uses a built-in 2 to 8 seconds by PC size, not no wait; used only with RAM pacing on. | 0 |
Wait when RAM runs lowNEXUS_PAUSE_HIGH_MS | Wait between tests, in milliseconds (1000 = 1 second), when free RAM is running low. 0 (default) uses a built-in 4 to 15 seconds by PC size, not no wait; used only with RAM pacing on. | 0 |
Wait when RAM is fullNEXUS_PAUSE_CRITICAL_MS | Wait between tests, in milliseconds (1000 = 1 second), when RAM is almost full. 0 (default) uses a built-in 8 to 25 seconds by PC size, not no wait; used only with RAM pacing on. | 0 |
Devices & Mobile
Phones to test on and imitate.
| Setting | What it does | Default |
|---|---|---|
Phone connection portNEXUS_DEVICE_CDP_PORT | The network port number your computer uses to talk to Chrome on a connected Android phone. Change it only if another program already uses 9333, the default. | 9333 |
Phone browser app IDNEXUS_DEVICE_CHROME_PKG | The app ID of the browser to test on a connected Android phone. Change it only if the phone uses another browser; the default is regular Chrome (com.android.chrome). | com.android.chrome |
Control phone from PCNEXUS_MIRROR_CONTROL | Lets you tap and type on the phone from its mirrored window on your computer. Turn it off for a view-only window that ignores your clicks; the default is on. | true |
High-end phone to imitateNEXUS_TIER_HIGH_DEVICE | The phone model imitated in high-end runs: screen size, browser identity and touch. It is a simulation in Safari's engine, not a physical iPhone; the default is iPhone 13. | iPhone 13 |
Mid-range phone to imitateNEXUS_TIER_MID_DEVICE | The phone model imitated in standard mobile runs: screen size, browser identity and touch. Pick an Android phone; the default is Pixel 5. | Pixel 5 |
Low-end phone to imitateNEXUS_TIER_LOW_DEVICE | The phone model imitated in low-end runs, which also slow the processor down. Pick an Android phone; if you leave it empty, a built-in budget phone (Nokia 1) is used. | Empty |
Low-end slowdown factorNEXUS_CPU_THROTTLE_RATE | How many times slower the processor runs in low-end phone tests, to mimic a weak phone. Use 2 to 20 (higher is slower); the default is 4, in Chrome-based browsers only. | 4 |
Slow networkNEXUS_NETWORK_PROFILE | Runs every test on a slower connection to see your site on a weak mobile signal: off (default), fast-4g, slow-4g, slow-3g or offline. Chrome-based browsers and real Android phones only. | off |
Evidence & Retention
What proof to save and how long.
| Setting | What it does | Default |
|---|---|---|
Record failure videosNEXUS_VIDEO_ENABLED | Records a video of each test so a failing one can keep it. Turn it off to save computer power and disk space, but no failure will have a video; the default is on. | true |
Failures that keep videoNEXUS_VIDEO_VERDICTS | Pick which results keep their video: failed, failed after retries, failed under chaos, timed out, or blocked. Empty or none keeps no videos; the default is the first three. | BREACHED,BREACHED_FLAKY,CHAOS_BREACHED |
Record step-by-step replayNEXUS_TRACE_ENABLED | Records every action and page state of each test, then saves the replay with a failure's bug report. Turn it off on a small computer to save power; the default is on. | true |
Bug reports kept per testNEXUS_BUGREPORT_RETAIN | How many failure reports to keep for each test and browser. Older ones are deleted for good, so raise it if you need a longer record; the default is 20. | 20 |
Passing screenshots keptNEXUS_PASSED_RETAIN | How many screenshots of passing runs to keep for each test and browser. Older ones are deleted for good; the default is 5. | 5 |
Smart Monkey sessions keptNEXUS_MONKEY_RETAIN | How many Smart Monkey sessions (random clicking and typing on your app) to keep. Older sessions are deleted for good; the default is 10. | 10 |
Run records keptNEXUS_RUN_CONTEXT_RETAIN | How many runs keep a record of what they tested against, plus the app's log. Older records are deleted for good; the default is 100. | 100 |
Keep proof of recovered passesNEXUS_RECOVERED_RETAIN | Saves a screenshot and notes for tests that passed only after a retry or after the app repaired a changed page element by itself. Turn it off to keep nothing for them; the default is on. | true |
Total evidence limit (GB)NEXUS_EVIDENCE_MAX_GB | The most disk space all evidence may use. After each run, the oldest is deleted for good, passing runs first, but each test keeps its newest run; the default is 20 GB. | 20 |
Free disk to keep (GB)NEXUS_MIN_FREE_GB | The free space your disk must keep. Below it, the oldest evidence is deleted for good even under the total limit (0 turns this off); the default is 10 GB. | 10 |
Run history lengthNEXUS_HISTORY_RETAIN | How many past results to remember for each test and browser, which feed trends and charts. Raise it if a test runs many times a day; the default is 50. | 50 |
Privacy & Stealth
Ad blocking and hiding automation from sites.
| Setting | What it does | Default |
|---|---|---|
Hide that tests are automatedNEXUS_STEALTH_ENABLED | Makes the test browser look like a regular person's, so sites that block bots let it in. It is not used in Security scans or on a physical phone; the default is off. | false |
Block ads during testsNEXUS_BLOCK_ADS | Stops ad networks from loading while you record and run tests, so ad pop-ups cannot cover buttons. Your own app is never blocked; the default is on, and Security scans do not use it. | true |
Reports
Executive PDF/HTML report.
| Setting | What it does | Default |
|---|---|---|
Company name on reportsORG_ID | The organization name printed on your PDF reports. Studio fills it from your profile when you first open it; if you leave it empty, your computer's name is used. | Empty |
Report languageNEXUS_PDF_LANGUAGE | The language of the printable summary report made after a full run. Choose English (en) or Spanish (es); the default is English. | en |
Sign-off name on reportsNEXUS_QA_ENGINEER_NAME | The name shown in the sign-off section of your reports. Set it to the person who approves the results; the default is QA Engineer. | QA Engineer |
Notifications
Telegram, Slack and Teams alerts per test.
| Setting | What it does | Default |
|---|---|---|
Telegram alert per failureNEXUS_TELEGRAM_NOTIFY | Sends a Telegram message for each failing test. It works only when Telegram is also enabled and connected below; the default is off, so enabling Telegram does not flood you. | false |
Slack alert per failureNEXUS_SLACK_NOTIFY | Sends a Slack message for each failed, unstable, chaos or visual-change test. It works only when Slack is also enabled and connected below; the default is off. | false |
Telegram alert on passesNEXUS_NOTIFY_ON_PASS | Also sends a Telegram message when a test passes. It needs the Telegram failure alerts switched on too, and gets noisy in big suites; the default is off. | false |
Teams alert per failureNEXUS_TEAMS_NOTIFY | Sends a Microsoft Teams message for each failed, unstable, chaos or visual-change test. It works only when Teams is also enabled and connected below; the default is off. | false |
Integrations
Slack, Teams, Jira, Azure DevOps, GitHub Issues, Telegram.
| Setting | What it does | Default |
|---|---|---|
Send alerts to TelegramTELEGRAM_ENABLED | Turns on test summaries and files you share going to Telegram, an outside service. Off by default; keep it off if your company does not allow data to leave this computer. | false |
Telegram bot access codeTELEGRAM_TOKEN | The secret code for your own Telegram bot (a free helper account). Get it by sending /newbot to @BotFather in Telegram; it stays on this computer and is never shared. | Empty. Saved only on this computer. |
Telegram chat for alertsTELEGRAM_CHAT_ID | The number that identifies the Telegram chat that receives alerts. Filled in for you when you scan the QR code with Connect in Settings → Integrations. | Empty |
Create Jira tickets for failuresJIRA_ENABLED | Opens a Jira Bug when a test fails and updates it on later runs. Turned on for you when you save Jira Connect, where you paste any link from your Jira. | false |
Jira site addressJIRA_BASE_URL | The web address of your Jira, like https://yourteam.atlassian.net. Filled in for you when you paste any link from your Jira into Connect. | Empty |
Jira sign-in emailJIRA_EMAIL | The email address you use to sign in to Jira. You enter it in Jira Connect together with the access token. | Empty |
Jira access tokenJIRA_API_TOKEN | A password-like code that lets the Studio use your Jira account. Create it in your Atlassian account under Security → API tokens; it stays on this computer and is never shared. | Empty. Saved only on this computer. |
Jira project for Bug ticketsJIRA_PROJECT_KEY | The short code before every ticket number in the project, like QA in QA-123. Filled in when you pick the project in Jira Connect. | QA |
Jira status when test passesJIRA_DONE_TRANSITION | The status a Bug moves to when its test passes again on every browser, such as Done. Empty uses Done; if your Jira has no such status, the Studio only adds a comment. | Done |
Attach full recording to ticketsNEXUS_ISSUE_ATTACH_TRACE | Adds the technical recording and raw log to Jira and Azure tickets. Off by default, because they can contain cookies and typed passwords that everyone on the project can open. | false |
Jira search for escaped bugsNEXUS_JIRA_ESCAPED_JQL | A Jira search filter that finds bugs that reached production, like status = Done AND labels = production. Empty means the escaped-bug metrics show "not configured". | Empty |
Create Azure work items for failuresAZURE_BOARDS_ENABLED | Creates an Azure Boards work item (a ticket) when a test fails and updates it on later runs. Turned on for you when you save Connect Azure DevOps. | false |
Azure DevOps organization addressAZURE_DEVOPS_ORG_URL | The web address of your organization, like https://dev.azure.com/yourcompany. Filled in for you when you paste any Azure DevOps link into Connect. | Empty |
Azure DevOps project nameAZURE_DEVOPS_PROJECT | The project in your organization that receives the work items and runs the pipeline. Filled in when you pick it in Connect Azure DevOps. | Empty |
Azure DevOps access tokenAZURE_DEVOPS_PAT | A password-like code (personal access token) for your Azure account, created in User settings → Personal access tokens. It stays on this computer and is never shared. | Empty. Saved only on this computer. |
Azure ticket type for failuresAZURE_BOARDS_WORK_ITEM_TYPE | The kind of work item created for a failure, such as Bug. It must exist in your project; empty uses Bug. | Bug |
Azure state when test passesAZURE_BOARDS_DONE_STATE | The state a work item moves to when its test passes again, such as Resolved. Empty uses Resolved; if your project refuses it, the Studio only adds a comment. | Resolved |
Azure pipeline to run in CIAZURE_PIPELINE_ID | The number of the Azure pipeline that Run in CI starts. Open the pipeline in Azure DevOps and copy the number after definitionId= in the address bar. | Empty |
Send alerts to SlackSLACK_ENABLED | Posts test failures, summaries and other alerts to Slack. Off by default; turned on for you when you save Slack Connect, which can send a test message. | false |
Slack channel for alertsSLACK_WEBHOOK_URL | A private Slack link that lets the Studio post to one channel. Create it in Slack → Your apps → Incoming Webhooks; it stays on this computer and is never shared. | Empty. Saved only on this computer. |
Send alerts to Microsoft TeamsTEAMS_ENABLED | Posts test failures and summaries to a Teams channel. Off by default: saving the Teams webhook turns it on, and it can send a test message. | false |
Teams channel for alertsTEAMS_WEBHOOK_URL | A private link (a webhook) that lets the Studio post to one Teams channel. Make it in the channel’s ··· menu → Workflows → “Post to a channel when a webhook request is received”. | Empty. Saved only on this computer. |
Create GitHub issues for failuresGITHUB_ISSUES_ENABLED | Opens a GitHub issue when a test fails, comments when it fails again, and closes it when the test passes. Turned on when you save the GitHub Issues card. | false |
GitHub access tokenGITHUB_ISSUES_TOKEN | A password-like code (token) that lets the Studio open issues in one repository. Create it in GitHub with Issues set to Read and write; it stays on this computer. | Empty. Saved only on this computer. |
GitHub repository for issuesGITHUB_ISSUES_REPO | The repository that receives the issues, written owner/repo like acme/web. Pick it from the list in the GitHub Issues card. | Empty |
Send tickets to your own systemTICKETS_HOOK_ENABLED | Sends each failed test to a web address you own, as a signed message, so your own tool can open the ticket. Off by default; it also needs a “webhook” destination (an entry in the tickets setup). | false |
Address for your tickets systemTICKETS_WEBHOOK_URL | The https web address that receives each ticket as a message. It stays on this computer and is never shown again after saving. | Empty. Saved only on this computer. |
Signing password for your ticketsTICKETS_WEBHOOK_SECRET | A password of at least 16 characters. Each message is signed with it, so your system can check that the message really came from here. | Empty. Saved only on this computer. |
GitHub token for CI/CDGITHUB_CI_TOKEN | A password-like code (token) that saves your CI secrets in GitHub without the gh program. Give it Secrets: Read and write; empty uses gh. | Empty. Saved only on this computer. |
Execution & Other
Third-party keys for outside tools.
| Setting | What it does | Default |
|---|---|---|
Apollo API keyAPOLLO_API_KEY | Key for the Apollo.io sales-contact service, created in your Apollo account settings under API. Nothing in Nexus Studio uses it, so leave it empty unless your own tools read it. | Empty. Saved only on this computer. |
Phone orientationNEXUS_EMU_ORIENTATION | Portrait or landscape for every phone run. Empty keeps the phone upright, as it comes. | Empty |
Phone locationNEXUS_EMU_GEO | Where the phone says it is, as latitude,longitude (for example 4.711,-74.0721). The page gets it without asking. | Empty |
Phone languageNEXUS_EMU_LOCALE | The language and region the phone reports, like es-CO or pt-BR. Empty keeps the phone's own. | Empty |
Phone time zoneNEXUS_EMU_TIMEZONE | The time zone the phone reports, like America/Bogota. Empty keeps this computer's. | Empty |
Phone dark modeNEXUS_EMU_COLOR_SCHEME | light, dark or no-preference: what the page sees as the phone's colour setting. | Empty |
Phone reduced motionNEXUS_EMU_REDUCED_MOTION | reduce makes the page see a phone set to fewer animations; no-preference turns that off. | Empty |
Open Linear issues for failuresLINEAR_ENABLED | Opens one Linear issue per broken test, comments when it fails again and closes it when it passes. Off by default; it also needs a “linear” destination in the tickets settings. | false |
Linear API keyLINEAR_API_KEY | A personal API key from Linear (Settings → Security & access → Personal API keys). It stays on this computer and is never shown again after saving. | Empty. Saved only on this computer. |
Linear teamLINEAR_TEAM_ID | The id of the Linear team that receives the issues. A destination can name another team with its own override. | Empty |
Open GitLab issues for failuresGITLAB_ISSUES_ENABLED | Opens one GitLab issue per broken test, adds a note when it fails again and closes it when it passes. Off by default; it also needs a “gitlab” destination in the tickets settings. | false |
GitLab token for issuesGITLAB_ISSUES_TOKEN | A GitLab access token with the api scope. It is only sent over https to your GitLab, stays on this computer and is never shown again after saving. | Empty. Saved only on this computer. |
GitLab project for issuesGITLAB_ISSUES_PROJECT | The project that receives the issues: its number, or its path like group/name. The GitLab address is the one CI/CD uses (gitlab.com by default). | Empty |
Page on-call in PagerDutyPAGERDUTY_ENABLED | Triggers one PagerDuty alert per broken test and resolves it when the test passes again. Off by default; it also needs a “pagerduty” destination in the tickets settings. | false |
PagerDuty integration keyPAGERDUTY_ROUTING_KEY | The Events API v2 integration key of the PagerDuty service to alert. It stays on this computer and is never shown again after saving. | Empty. Saved only on this computer. |
Alert on-call in OpsgenieOPSGENIE_ENABLED | Opens one Opsgenie alert per broken test, adds a note when it fails again and closes it when it passes. Off by default; it also needs an “opsgenie” destination. | false |
Opsgenie API keyOPSGENIE_API_KEY | An Opsgenie API key allowed to create and close alerts. It stays on this computer and is never shown again after saving. | Empty. Saved only on this computer. |
Opsgenie regionOPSGENIE_API_URL | https://api.opsgenie.com, or https://api.eu.opsgenie.com when your Opsgenie account lives in the EU. | https://api.opsgenie.com |
Send results to TestRailTESTRAIL_ENABLED | At the end of each run, opens one TestRail run with every test that names its case (a // nexus:testrail C123 comment) and posts pass or fail. Off by default. | false |
TestRail addressTESTRAIL_URL | Your TestRail site, like https://yourcompany.testrail.io. Only https is accepted. | Empty |
TestRail userTESTRAIL_USER | The email of the TestRail account that posts the results. | Empty |
TestRail API keyTESTRAIL_API_KEY | An API key of that TestRail account (My Settings → API Keys). It stays on this computer and is never shown again after saving. | Empty. Saved only on this computer. |
TestRail projectTESTRAIL_PROJECT_ID | The number of the TestRail project the runs go to (the P in its address, without the P). | Empty |