screenci__screenci/docs

Screenci Docs

Developer documentation for the screenci library.

Prerequisites

Before using screenci you only need Node.js and npm. npm is included with the standard Node.js installer.

If you are unsure whether Node.js is installed, check:

node --version

If that command is missing or prints an old version, install Node.js from the official Node.js installation docs. Node.js 20+ is recommended.

Contents

Doc	Description
Introduction	Overview of ScreenCI and where to start
Getting Started	Record video and subtitles from a ScreenCI project
Playwright vs ScreenCI	Compare Playwright tests with ScreenCI video scripts
AI-Supported Editing	AI-facing docs access, llms.txt, and MCP workflows
Localization & Narrations	Multi-language narration and localized UI videos
Assets	Image and video overlays with createAssets
Public URLs	Publish stable public video, thumbnail, and subtitle URLs
Update screenci with npm	Update the installed screenci package and refresh skills
CLI Commands	Complete command reference for screenci
Configuration	defineConfig options, per-test overrides, defaults
Writing Video Tests	How to use video(), createNarration(), multiple tests, auth, etc.
API Reference	Full reference for all exported functions and types
Public API	Public endpoints for published videos, thumbnails, and subtitles