screenci__screenci/docs

Screenci Docs

Developer documentation for the screenci library.

Prerequisites

Before using screenci you need:

• Node.js — check the installed version; Node.js 20+ is recommended, and see the official Node.js installation guide if you need to install it
• Podman or Docker — Podman 5+ or Docker 28+ is recommended; on macOS, install Podman from podman.io or use the community-maintained Homebrew package if you prefer

macOS

node --version # Node.js 20+ recommended
podman --version # Podman 5+ recommended
docker --version # alternatively: use this if Podman is missing; Docker 28+ recommended
# Node.js install guide: https://nodejs.org/en/download
# Podman install guide: https://podman.io/docs/installation#macos

Windows

node --version # Node.js 20+ recommended
podman --version # Podman 5+ recommended
docker --version # alternatively: use this if Podman is missing; Docker 28+ recommended
# Node.js install guide: https://nodejs.org/en/download
# Podman install guide: https://podman.io/docs/installation#windows

Linux/WSL2

node --version # Node.js 20+ recommended
podman --version # Podman 5+ recommended
docker --version # alternatively: use this if Podman is missing; Docker 28+ recommended
# Node.js install guide: https://nodejs.org/en/download
# Podman install guide: https://podman.io/docs/installation#ubuntu

Contents

Doc	Description
Introduction	Overview of ScreenCI and where to start
Getting Started	Install screenci, scaffold a project, and record your first video
Recording Flows	Write polished product video scripts with cues and zoom
Deployment Automation	Automate rendering and updates in CI/CD
Editing by Typing	Update scripts and narration without full reshoots
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
CLI Commands	Complete command reference for screenci
Prerequisites: macOS	macOS setup steps for Node.js and Podman
Prerequisites: Windows	Windows setup steps for Node.js and Podman
Prerequisites: Linux	Linux setup steps for Node.js and Podman
Configuration	defineConfig options, per-test overrides, defaults
Writing Video Tests	How to use video(), cue(), multiple tests, auth, etc.
API Reference	Full reference for all exported functions and types
Public API	Public endpoints for published videos, thumbnails, and subtitles