Cap README

The project's README from github.com/CapSoftware/Cap. As one markdown file: README.md.

Cap logo

Cap

Beautiful, shareable screen recordings. Open source, fast, and built for teams that want to own their data.

Website | Download | Docs | Pricing | Discord

Open bounties

Cap app preview

Cap is the open source alternative to Loom. It gives you fast screen recording, polished local editing, instant share links, comments, transcripts, analytics, team workspaces, custom domains, custom S3 storage, and full self-hosting when you need complete control.

Use Cap for product demos, bug reports, onboarding, tutorials, design reviews, engineering walkthroughs, async standups, client updates, and any moment where showing the work is faster than scheduling another call.

Why Cap

Recording Modes

Mode Best for How it works
Instant Mode Fast feedback, bug reports, async updates Cap uploads while you record, then gives you a share link as soon as recording stops.
Studio Mode Product demos, tutorials, launches, client work Cap records locally, opens the editor, and lets you export or share a polished video.

Data Ownership

Cap is designed for people and teams who do not want their recording workflow locked inside a black box.

Get Started

For most users, the fastest path is:

  1. Download Cap for macOS or Windows from cap.so/download.
  2. Sign in or create an account.
  3. Choose Instant Mode or Studio Mode.
  4. Record your first Cap.
  5. Share the link, export the file, or keep it local.

The full product docs live at cap.so/docs.

Self-Hosting

The fastest way to self-host Cap Web is Docker Compose:

git clone https://github.com/CapSoftware/Cap.git
cd Cap
docker compose up -d

Cap will be available at http://localhost:3000.

Login links appear in the service logs when email is not configured:

docker compose logs cap-web

Deployment Options

Method Best for
Docker Compose VPS, home servers, and any Docker-capable host
Railway One-click managed hosting
Coolify Self-hosted PaaS deployments with docker-compose.coolify.yml

Deploy on Railway

For production, configure public URLs and replace the default secrets before exposing the deployment to the internet:

CAP_URL=https://cap.yourdomain.com
S3_PUBLIC_URL=https://s3.yourdomain.com

See the self-hosting guide for email setup, AI providers, SSL, storage, production hardening, and troubleshooting.

Local Development

Cap is a Turborepo monorepo with Rust, TypeScript, Tauri, SolidStart, Next.js, Drizzle, MySQL, Tailwind CSS, and shared media crates.

Requirements:

Install and set up the repo:

bun install
bun run env-setup
bun run cap-setup

Common commands:

Command Purpose
bun run dev Start the full local development stack
bun run dev:web Start the web app without the desktop app
bun run dev:desktop Start the desktop app
bun run build Build the workspace
bun run tauri:build Build the desktop release
bun run lint Run Biome linting
bun run format Format with Biome
bun run typecheck Run TypeScript project references
cargo test -p <crate> Run Rust tests for a crate

Database commands:

Command Purpose
bun run db:generate Generate database artifacts
bun run db:push Push schema changes
bun run db:studio Open Drizzle Studio

Repository Map

Path What lives there
apps/desktop Tauri v2 desktop app with SolidStart UI and Rust backend
apps/web Next.js web app for marketing, docs, dashboard, sharing, API routes, and auth
apps/cli Rust CLI
apps/media-server Media processing service used by the web app
apps/discord-bot Discord integration
packages/database Drizzle schema and database access
packages/ui Shared React UI
packages/ui-solid Shared Solid UI
packages/web-backend Backend service layer
packages/web-domain Web domain models and types
packages/env Environment validation
packages/sdk-embed Embed SDK
packages/sdk-recorder Recorder SDK
crates/* Recording, capture, camera, audio, encoding, rendering, muxing, export, and test crates
scripts/* Setup, analytics, build, and maintenance tooling
infra/* Infrastructure configuration

The web API uses Effect and @effect/platform HTTP APIs. Desktop capture and export paths are backed by Rust crates for fast recording, rendering, and platform-specific media access.

Analytics

Cap uses Tinybird for viewer telemetry dashboards. Set TINYBIRD_ADMIN_TOKEN or TINYBIRD_TOKEN before running analytics commands.

Command Purpose
bun run analytics:setup Deploy Tinybird datasources and pipes from scripts/analytics/tinybird
bun run analytics:check Validate that the Tinybird workspace matches the app expectations

analytics:setup can remove Tinybird resources outside the checked-in analytics configuration. Use it only against the workspace you intend to manage from this repo.

Contributing

Cap is built in public. Issues, pull requests, design feedback, bug reports, docs fixes, and bounties are welcome.

License

Portions of this software are licensed as follows:

Cap (CapSoftware/Cap)

Searching Database…

23.4K ·GitHub
这是什么?一个开源的 Loom 替代品:它能录制屏幕、摄像头和麦克风,并把录制内容变成可分享的链接或导出的视频——适合做演示、提交 bug 报告、写教程和异步站会。
这是桌面应用还是网页服务?两者都有:用 Tauri 和 Rust 构建的原生桌面应用负责录制,另外还有一个 Next.js 网页控制台,用来查看、分享和管理录制内容。这个 monorepo 还附带一个 Rust CLI、一个媒体服务器和一个 Discord 机器人。
我怎么录制并分享第一个视频?从 cap.so/download 下载 macOS 或 Windows 版 Cap,登录后选择 Instant 或 Studio 模式,录制你的第一个 Cap——然后分享链接、导出文件,或者保存在本地。
除了这个应用,我还需要安装别的东西吗?录制的话什么都不用装——只需要应用和一个账号。如果想从源码构建或自行部署,则需要 Node.js 20+、Bun 1.4.0、Rust 1.88+,以及用于 MySQL 和 MinIO 的 Docker。
有 Linux 版本吗?没有 Linux 桌面应用:录制器只提供 macOS 和 Windows 版本。网页控制台在任何浏览器里都能用,自行部署也可以跑在任何支持 Docker 的主机上。
我能在自己的服务器上自行部署整套平台吗?可以。Docker Compose 能运行 Cap Web、API、数据库、媒体服务器和对象存储;Railway 和 Coolify 提供一键部署。在桌面应用的 Settings > Cap Server URL 里填上你的实例地址即可。
我的录制内容必须存在 Cap 的云端吗?不必——你可以用 Cap Cloud,接入自己的 S3 兼容存储桶(AWS S3、Cloudflare R2、Backblaze B2、MinIO、Wasabi),把录制内容保存在本地,或者自行部署。链接可以公开或私密,可加密码保护,还能绑定你自己的域名。
Instant 模式和 Studio 模式有什么区别?Instant 模式边录边上传,你一停止录制就拿到分享链接——专为快速反馈和 bug 报告设计。Studio 模式在本地录制,并打开一个编辑器,提供背景、缩放、剪辑和字幕功能,方便制作精良的视频再导出或分享。
Cap AI 能自动做些什么?它会自动为你的录制内容生成标题、摘要、可点击的章节、字幕和文字稿。
我有一批 Loom 视频,能迁移过来吗?可以——Cap 能导入你现有的 Loom 视频,让整个视频库集中在一处。
它支持围绕录制内容进行团队协作吗?分享页面带有评论、表情反应、文字稿和观看数据分析,团队工作区能让反馈始终挂在对应视频上。分享可设为公开或私密并可加密码,页面还能通过你自己的域名来访问。
Size
436.6 MB
Stars
23.4K
Age
2y
Commits · 90 Days