ScreenCIConfig
ScreenCIConfig =
Omit<PlaywrightTestConfig,"retries"|"testDir"|"testMatch"|"use"|"projects"> &object
Defined in: types.ts:1397
Type Declaration
Section titled “Type Declaration”enableCaptureAudio?
Section titled “enableCaptureAudio?”
optionalenableCaptureAudio?:boolean
Enables system audio capture for the whole run. When true, the recording
browser is launched in audio mode (unmuted, new headless) so that videos
setting recordOptions.captureAudio actually capture sound.
This is a launch-time switch, decided once per worker before any individual
video’s options are known, so it must live here at config root rather than
in a video’s video.use(). A video that sets captureAudio while this is
false throws at record time with a link to the setup docs.
Default
Section titled “Default”falseenvFile?
Section titled “envFile?”
optionalenvFile?:string
Path to a .env file to load before uploading. Relative to the screenci.config.ts file. Use this to load SCREENCI_SECRET and other env vars.
Example
Section titled “Example”'.env'projectId?
Section titled “projectId?”
optionalprojectId?:string
Set by screenci setup for a project created from the web app with a
setup code. Informational for the CLI: the project-scoped secret pins the
project server-side; the CLI uses this only to detect a workspace that
belongs to another project.
projectName
Section titled “projectName”projectName:
string
Name of the project. Used to identify the project in screenci.com.
projects?
Section titled “projects?”
optionalprojects?:Omit<Project,"use"> &object[]
record?
Section titled “record?”
optionalrecord?:object
Options that only affect the screenci export command.
record.upload?
Section titled “record.upload?”
optionalupload?:RecordUploadPolicy
Controls whether recordings are uploaded after partial Playwright failures.
Default
Section titled “Default”'passed-only'recordingDir?
Section titled “recordingDir?”
optionalrecordingDir?:string
Directory that will be searched recursively for *.screenci.* files.
Matches files like example.screenci.ts, demo.screenci.js, etc.
Defaults to './recordings'.
optionaltest?:object
Options that only affect the screenci test command.
test.mockRecord?
Section titled “test.mockRecord?”
optionalmockRecord?:boolean
Keeps recording-style timings enabled during screenci test.
Equivalent to passing --mock-record on the CLI.
Default
Section titled “Default”falseuploadSources?
Section titled “uploadSources?”
optionaluploadSources?:boolean
Upload the island’s text sources (scripts and config, never .env,
lockfiles, or media) with each preview/export so the web app can show
them and hand them to a coding agent (Add video, Edit). Set false to
keep the scripts off ScreenCI; those prompts then need the repository
URL from AI context.
Default
Section titled “Default”true
optionaluse?:Omit<NonNullable<PlaywrightTestConfig["use"]>,"trace"> &object
Type Declaration
Section titled “Type Declaration”actionTimeout?
Section titled “actionTimeout?”
optionalactionTimeout?:number
Timeout in milliseconds for individual actions like click(), fill(), etc.
Separate from the overall test timeout. Defaults to 30 seconds so actions don’t inherit the long test timeout.
Default
Section titled “Default”30000navigationTimeout?
Section titled “navigationTimeout?”
optionalnavigationTimeout?:number
Timeout in milliseconds for page navigations like goto(), waitForNavigation(), etc.
Separate from the overall test timeout. Defaults to 30 seconds.
Default
Section titled “Default”30000trace?
Section titled “trace?”
optionaltrace?:NonNullable<NonNullable<PlaywrightTestConfig["use"]>["trace"]>
When to record traces during test execution.
Uses Playwright’s native trace option type.
Default
Section titled “Default”'retain-on-failure'webServer?
Section titled “webServer?”
optionalwebServer?:PlaywrightTestConfig["webServer"]
Starts and reuses a development server through Playwright before running videos.
This is useful for generated ScreenCI projects that should record against the app in the parent project directory.