Skip to main content

Cypress.config

get and set configuration options in your tests.

caution
Scope

Configuration set using Cypress.config is only in scope for the current spec file.

Cypress runs each spec file in isolation: the browser is exited between specs. Configuration changed in one spec won't be visible in other specs.

caution
Note

Not all configuration values can be changed during runtime. See Notes below for details.

Syntax

Cypress.config()
Cypress.config(name)
Cypress.config(name, value)
Cypress.config(object)

Arguments

name (String)

The name of the configuration to get or set.

value (Any)

The value of the configuration to set.

object (Object)

Set multiple configuration options with an object literal.

Examples

No Arguments

Get all configuration options from the Cypress configuration

const { defineConfig } = require('cypress')

module.exports = defineConfig({
defaultCommandTimeout: 10000,
})
Cypress.config() // => {defaultCommandTimeout: 10000, pageLoadTimeout: 30000, ...}

Name

Return a single configuration option from the Cypress configuration

const { defineConfig } = require('cypress')

module.exports = defineConfig({
pageLoadTimeout: 60000,
})
Cypress.config('pageLoadTimeout') // => 60000

Name and Value

Change the values of configuration options from the Cypress configuration from within your tests

caution
Scope

Remember, any changes that you make to configuration using this API will be in effect for the remainder of the tests in the same spec file.

const { defineConfig } = require('cypress')

module.exports = defineConfig({
viewportWidth: 1280,
viewportHeight: 720,
})
Cypress.config('viewportWidth', 800)

Cypress.config('viewportWidth') // => 800

Object

Override multiple options from the Cypress configuration by passing an object

const { defineConfig } = require('cypress')

module.exports = defineConfig({
defaultCommandTimeout: 4000,
pageLoadTimeout: 30000,
})
Cypress.config({
defaultCommandTimeout: 10000,
viewportHeight: 900,
})

Cypress.config() // => {defaultCommandTimeout: 10000, viewportHeight: 900, ...}

Notes

Not all config values can be changed at all times

Some configuration values are readonly and cannot be changed while running a test. Anything that's not directly under Cypress's control - like timeouts or environment variables - will be ignored at run-time. Be sure to review the list of test configuration options.

Test Configuration vs Cypress.config()

To apply specific Cypress configuration values to a suite or test, you can pass a test configuration object to the test or suite function.

While Cypress.config() changes configuration values through the entire spec file, using test configuration will only change configuration values during the suite or test where they are set. The values will then reset to the previous default values after the suite or test is complete.

See the full guide on test configuration.

Cypress.config() executes Synchronously

It's important to note that Cypress.config() executes synchronously and will not wait for the Cypress commands above it to execute. If you need to update your configuration mid-test, be sure to chain the asynchronously Cypress command.

it('using cy.then', () => {
cy.visit('/my-test_page')
cy.click('#download-html').then(() => {
Cypress.config('baseUrl', null)
})
cy.visit('/downloads/contents.html')
})

Why is it Cypress.config and not cy.config?

As a rule of thumb anything you call from Cypress affects global state. Anything you call from cy affects local state.

Since the configuration added or changed by Cypress.config is only in scope for the current spec file, you'd think that it should be cy.config and not Cypress.config…and you'd be right. The fact that Cypress.config affects local state is an artifact of the API evolving over time: Cypress.config used to affect global state—configuration added in one test spec file was available in other specs—but the Cypress team wisely made each spec run in isolation in 3.0.0 and by that time Cypress.config was public API.

History

VersionChanges
0.12.6Cypress.config added

See also