openscreen README

项目的 README,来自 github.com/getopenscreen/openscreen。合并为一个 markdown 文件:README.md。

OpenScreen Logo

OpenScreen

Make a demo video with one sentence in your AI agent:

Install the OpenScreen demo skill with `npx skills add getopenscreen/openscreen --skill openscreen-demo -y`, then follow it to make a demo video of this feature.

A free, open-source desktop app for recording your screen and turning the result into polished product demos and walkthroughs.

Editing a recording in OpenScreen: one click restyles the whole video, deleting a sentence in the transcript cuts it from the video, and the editor's agent adds a zoom on every click

License Latest Release CI Status Discord Sponsor Platform #5 Product of the Day on Product Hunt

getopenscreen/openscreen | Trendshift

[!NOTE] This is OpenScreen, continued. Siddharth Vaddem created the project and archived the original repository after v1.5.0. Development moved here with his approval, under the same name and the same MIT license.

A raw capture goes in and comes out ready to post — on X, Reddit, YouTube, a docs page, or a landing page. That is the category Screen Studio defined; OpenScreen is the open-source entry in it, and not a clone.

100% free for personal and commercial use, with nothing held behind a paywall.

Project status. OpenScreen is under active development — expect rough edges and occasional breaking changes, including to the .openscreen project format and the CLI. Bug reports are welcome: open an issue.

Core Features

Command-line interface (headless)

OpenScreen ships a CLI for scripts, CI, and AI coding agents: record the screen headlessly, edit the .openscreen project JSON programmatically (zooms, annotations, trims), and render MP4/GIF with the full export pipeline — no visible windows, NDJSON output with --json.

openscreen record --duration 20 --project demo.openscreen --json
openscreen export demo.openscreen -o demo.mp4 --json

See the CLI reference.

Let your AI agent ship the feature with its video

Paste this into your AI agent (Claude Code, Codex, Cursor…):

Install the OpenScreen demo skill with `npx skills add getopenscreen/openscreen --skill openscreen-demo -y`, then follow it to add a video of this change to the PR.

The skill sets everything up: it installs OpenScreen if it is missing (once you agree), connects its MCP server, then asks you to open a new session and say "continue the OpenScreen demo", the one step an agent cannot do for itself. By hand, in Claude Code, it is these two commands, where <executable> is the app's executable on your system (where to find it):

claude mcp add openscreen -- "<executable>" mcp
npx skills add getopenscreen/openscreen --skill openscreen-demo

From then on, ask: "Add a video of this change to the PR." The agent plans the storyboard, records the app, edits the take with OpenScreen's own editing tools, exports the MP4, checks it frame by frame, and attaches it to the pull request, where reviewers watch it in place. Ask for a launch demo instead and it drafts a post for X, which it publishes only once you say yes. Codex and the other clients are in AI editing.

Installation

Every platform has a recommended route below. On Windows that is the Microsoft Store; everywhere else it is the installer from the GitHub Releases page.

System requirements

Full table and notes on older integrated graphics: system requirements.

macOS

Install with Homebrew:

brew install --cask openscreen

Or download the .dmg installer directly from the Releases page and drag OpenScreen into your Applications folder. Builds from 1.9.0 onward are signed with a Developer ID certificate and notarized by Apple, so Gatekeeper does not block them and no terminal step is needed.

On first launch, open System Settings > Privacy & Security and grant the two permissions OpenScreen needs: Screen Recording and Accessibility. Recording cannot start until both are granted.

[!NOTE] macOS 15 and later re-ask for screen-recording permission periodically. That prompt comes from macOS itself and applies to every third-party screen recorder — it is not a sign that anything is wrong with your install or that an update broke something. Grant it again when asked.

[!NOTE] Upgrading from a version older than 1.9.0? Those builds were not signed with a Developer ID certificate, and macOS ties Screen Recording and Accessibility grants to an app's signature — so it cannot tell the new build is the same app, and the permissions you granted the old one do not carry over. If the new version won't record even after you grant them, remove OpenScreen's existing entries under System Settings > Privacy & Security (both Screen Recording and Accessibility), then launch it again and grant them when prompted.

[!NOTE] OpenScreen quits as soon as you pick what to record, or when the countdown starts? It is most likely a utility that quits apps once their last window closes, such as the Quit on close option of Vorssaint. It does not count OpenScreen's recording bar, which floats above other windows, so it quits OpenScreen whenever the bar hides or a source window closes. Add OpenScreen to that utility's exceptions, or turn the option off. The FAQ shows how to check which app asked OpenScreen to quit.

Windows

Recommended — Microsoft Store

Get OpenScreen from the Microsoft Store, or from a terminal:

winget install --source msstore OpenScreen

Microsoft signs the Store package during certification, so it installs with no security warning and updates itself.

Alternative — standalone installer

Download the .exe from the Releases page. Installers are provided for both x64 (Openscreen.Setup.<version>-x64.exe) and ARM64 (Openscreen.Setup.<version>-arm64.exe) — on an ARM64 device the x64 build runs under emulation and records poorly, so take the ARM64 one. Use this if you can't reach the Store — Windows LTSC, a locked-down work machine, an offline install, or if you want a specific older version.

[!NOTE] The .exe is not code-signed, so Windows SmartScreen shows "Windows protected your PC" and reports an unknown publisher. Choose More info → Run anyway to continue.

This is not a sign that something is wrong with the download: an unsigned installer earns SmartScreen's trust per file, so a brand-new build always starts out untrusted no matter how many people installed the previous one. Verifying the signature isn't an option here — there is nothing to verify. If you want the checked path, use the Store build above. If you use the .exe, download it only from the Releases page linked here.

[!NOTE] Recording bar not clickable in OpenScreen 2.0.0 on Windows 10? Run setx OPENSCREEN_DISABLE_CONTENT_PROTECTION 1, quit OpenScreen from its tray icon, then start it again. The bar can then appear in your recordings. The FAQ explains how to undo it once the fix ships.

Linux

Four packages are published to the Releases page for each version. Pick the one that matches your distro:

Debian / Ubuntu / Pop!_OS (.deb)

sudo apt install ./Openscreen-Linux-*.deb

Fedora / RHEL / CentOS (.rpm)

sudo dnf install ./Openscreen-Linux-*.rpm

Arch / Manjaro (.pacman)

sudo pacman -U Openscreen-Linux-*.pacman

Any distro (.AppImage)

chmod +x Openscreen-Linux-*.AppImage
./Openscreen-Linux-*.AppImage

NixOS / Nix (flake)

Try without installing:

nix run github:getopenscreen/openscreen

Install into your user profile:

nix profile install github:getopenscreen/openscreen

For a NixOS system config (flake):

{
  inputs.openscreen.url = "github:getopenscreen/openscreen";

  outputs = { nixpkgs, openscreen, ... }: {
    nixosConfigurations.<host> = nixpkgs.lib.nixosSystem {
      modules = [
        openscreen.nixosModules.default
        { programs.openscreen.enable = true; }
      ];
    };
  };
}

For Home Manager, use openscreen.homeManagerModules.default with the same programs.openscreen.enable = true;.

You may need to grant screen recording permissions depending on your desktop environment.

Sandbox error: If the AppImage fails to launch with a "sandbox" error, run it with --no-sandbox:

./Openscreen-Linux-*.AppImage --no-sandbox

Platform differences

Everything in the editor and export is the same on macOS, Windows, and Linux: zooms, backgrounds, motion blur, crop/trim/speed, blur regions, annotations, auto-captions, AI editing, projects, export, and all languages. All three now record through a native capture pipeline; the remaining differences are narrower than they used to be:

This repository is the community-maintained continuation of OpenScreen.

Official / trusted links:

For safety, install OpenScreen only from the official GitHub Releases linked from this repository, the Microsoft Store listing above, or the official Homebrew cask. Forks on GitHub and third-party websites using the OpenScreen name are not affiliated with this continuation unless explicitly listed here. There is no getopenscreen/tap Homebrew tap.

Community

OpenScreen is community-driven. If you need help, want to report a bug, or just want to chat with other users and contributors:


License

This project is licensed under the MIT License. By using this software, you agree that the authors are not liable for any issues, damages, or claims arising from its use.

openscreen (getopenscreen/openscreen)

正在搜索数据库…

这是什么?OpenScreen 是一款免费、开源的桌面应用,可以录制屏幕,并在编辑器中添加缩放、字幕、背景和标注,把录屏变成精致的产品演示或操作讲解视频。
它是 Screen Studio 的克隆版吗?不是。OpenScreen 是 Screen Studio 所开创品类中的开源产品,是一款独立开发的应用。实际上,在原作者将原仓库归档后,它是由社区维护的原 OpenScreen 项目的延续。
系统要求是什么?macOS 13(Ventura)或更高版本;Windows 1903 及以上版本,处理器为第 8 代 Intel 或 2000 系列及更新的 Ryzen;Linux 则需要 xdg-desktop-portal 和 PipeWire 才能进行原生录制(没有它们也能通过浏览器录制的备用方案使用)。最低 8GB 内存,建议 16GB。
不同平台之间有哪些差异需要我注意?有。在 Linux 上,光标点击效果需要手动设置 evdev 权限,因为 Wayland 没有提供鼠标按键的 portal 接口;系统音频录制需要 PipeWire(仅使用 PulseAudio 的旧环境可能无法录到)。Windows 独立版 .exe 没有数字签名,因此首次运行时会被 SmartScreen 拦截提示。
我的录屏或语音会被上传到什么地方吗?自动字幕在设备本地转录,不会上传,离线即可使用。可选的 AI 编辑助手默认关闭,只有当你提供自己的 Claude、OpenAI 或 Gemini 等服务商 API 密钥时才会启用。
Claude Code 或 Codex 这类 AI 编程代理能用它自动录制演示吗?可以。OpenScreen 提供了命令行工具(CLI)和 MCP 服务器,代理可以在无界面模式下录制、编辑项目 JSON(缩放、标注、裁剪)、渲染导出,并把成品视频附加到 pull request 中。
支持哪些导出格式和画质?支持 MP4 或 GIF,可选多种宽高比和分辨率。渲染与编码由 GPU 完成(macOS 使用 Metal,Windows 使用 D3D11,Linux 使用 Vulkan),并在不支持时自动回退到 CPU。
编辑助手支持哪些 AI 服务商?你可以使用自己的 API 密钥接入 Claude、OpenAI、Gemini、Mistral、OpenRouter、MiniMax 或任何兼容 OpenAI 接口的端点;默认全部不启用。
字幕和隐藏式字幕支持哪些语言?支持 15 种语言,包括英语、西班牙语、法语、德语、日语、韩语、俄语、土耳其语,以及简体中文和繁体中文。
有哪些类似的项目?Recordly, screenity, caplo, Cap, screenpipe, filmcraft, shrimply, autoclip
大小
281.2 MB
星标
7.5K
时长
8个月
提交 · 90 天