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: записывает экран, камеру и микрофон и превращает записи в ссылки для шаринга или готовые видеофайлы — для демо, отчётов о багах, туториалов и асинхронных стендапов.
Это десктоп-приложение или веб-сервис?И то и другое: нативное десктоп-приложение на Tauri и Rust для записи плюс веб-панель на Next.js для просмотра, шаринга и управления записями. В монорепозитории также входят Rust CLI, медиасервер и Discord-бот.
Как записать и расшарить первое видео?Скачайте Cap для macOS или Windows с cap.so/download, войдите в аккаунт, выберите режим Instant или Studio и запишите свой первый Cap — затем отправьте ссылку, экспортируйте файл или оставьте запись локально.
Нужно ли что-то устанавливать кроме приложения?Для записи — ничего, только приложение и аккаунт. Сборка или самостоятельный хостинг из исходников потребуют Node.js 20+, Bun 1.4.0, Rust 1.88+ и Docker для MySQL и MinIO.
Есть ли версия для Linux?Десктоп-приложения для Linux нет: рекордер выпускается только для macOS и Windows. Веб-панель работает в любом браузере, а self-hosted-версия запускается на любом хосте с 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 Mode отличается от Studio Mode?Instant Mode загружает видео прямо во время записи и выдаёт ссылку для шаринга сразу после остановки — идеально для быстрой обратной связи и отчётов о багах. Studio Mode записывает локально и открывает редактор с фонами, зумом, обрезкой и субтитрами для отполированных роликов, которые можно экспортировать или расшарить.
Что Cap AI умеет делать автоматически?Он автоматически создаёт для ваших записей заголовки, краткие описания, кликабельные главы, субтитры и транскрипты.
У меня большая библиотека видео в Loom — можно перенести её сюда?Да — Cap импортирует ваши существующие видео из Loom, так что вся библиотека останется в одном месте.
Есть ли совместная работа команды над записями?На страницах шаринга есть комментарии, реакции, транскрипты и аналитика просмотров, а командные воркспейсы привязывают обратную связь к видео. Шаринг может быть публичным или приватным, с паролем, а страницы можно размещать на своём домене.
Size
435.7 MB
Stars
23.4K
Age
2y
Commits · 90 Days