mirror of
https://github.com/screenci/screenci.git
synced 2026-09-19 08:57:46 +08:00
Olli Paloviita
54 lines
2.3 KiB
Plaintext
54 lines
2.3 KiB
Plaintext
# Overview
|
|
|
|
ScreenCI treats product videos as code. You describe a flow once as a
|
|
Playwright-based script. ScreenCI drives your app, adds narration and camera
|
|
motion, and produces a polished video. When the UI changes, you rerun the
|
|
script and the video regenerates.
|
|
|
|
## How it works
|
|
|
|
Record with the CLI, refine in the web editor, then export and deliver the
|
|
final video where your team needs it.
|
|
|
|
<!-- screenci-image:VideoLifecycle -->
|
|
|
|
- **Record.** `screenci record` captures the flow on your machine and uploads
|
|
the recording. By default this only refreshes the video's live preview in
|
|
the web editor, so you can iterate for free.
|
|
- **Refine.** The [Editor](/docs/guides/editor) shows a live preview and a
|
|
timeline. With `screenci edit` running, every edit you make in the browser
|
|
(narration, overlays, cuts, timings, render options) is written back into
|
|
your script, so code stays the source of truth.
|
|
- **Export.** When the preview looks right, export (the Export button, or
|
|
`screenci record --export`) to render the finished video, then serve it
|
|
from a stable public URL.
|
|
|
|
The CLI runs everything that touches your app locally, so the only thing that
|
|
leaves your machine is the raw recording plus timing data, not your source code.
|
|
The CLI itself is [open source](https://github.com/screenci/screenci).
|
|
|
|
## Two ways to set up
|
|
|
|
Pick the path that fits how you work.
|
|
|
|
- **[Agent integration](/docs/agent-integration) (recommended).** Point a coding
|
|
agent (Claude Code, Codex, Cursor, or similar) at the integration brief. It
|
|
scaffolds ScreenCI, authors a video for the flow you describe, and records it,
|
|
with you mostly reviewing the result.
|
|
- **[Manual setup & first video](/docs/manual-setup).** Scaffold ScreenCI
|
|
yourself, write the `.screenci.ts` script by hand, run it locally, and record the
|
|
final video.
|
|
|
|
Either way, once a video exists you can dig into the rest of the docs to refine
|
|
it: [Editor](/docs/guides/editor),
|
|
[Video Script Basics](/docs/video-script-basics),
|
|
[Camera and Zooming](/docs/guides/camera-and-zooming),
|
|
[Narration](/docs/guides/narration), and
|
|
[Public URLs and Embeds](/docs/guides/public-urls-and-embeds).
|
|
|
|
## Community
|
|
|
|
Need support, hit a bug, or want to share what you recorded? Join the
|
|
[ScreenCI community on Discord](https://discord.gg/DyjSRFzeBc) to get help, report
|
|
issues, and talk to other users.
|