Reading the repo

Opening the box…

How to install Cap on macOS (CapSoftware/Cap) · gitmanual

How to install on macOS

CapSoftware/Cap

Open source Loom alternative. Beautiful, shareable screen recordings.

Node.jsRust#app#cap#coss#loom

Difficulty: Involved
Time: 30 min or more
Stars: ★ 24,517
Activity: Updated this month
License: Not detected
Open issues: 418
Got it running: Be the first
Looked up: 4 h ago

Saved setup from 4 h ago

Start here

Website ↗cap.soThe project's own site.Docs ↗cap.soLinked from the README.

Will it work on my device?

Yes, with Docker on macOS

It's a self-hosted app: the README runs it with Docker, and you open it in your browser.
On macOS that means installing Docker Desktop first.

Checking for

macOS Windows Linux

Run it with Docker

A self-hosted app: Docker runs it on your computer and you open it in the browser. Needs Docker Desktop (or Docker Engine on Linux). Run docker compose commands inside the cloned repo folder.

Docker

docker compose up -d

From the README, exactly as the maintainers wrote it.

Did you get it running?

No reports for macOS yet.

Still stuck? Ask an AI

Opens a chat with this manual already filled in, for macOS. It uses your own account; gitmanual sends nothing.

Ask Claude Ask ChatGPT

Parts list

1×Node.js >=24runtime
1×Bun runtime
1×Rust 1.88.0runtime
1×bun bun@1.4.4package manager
1×MySQL service
1×MinIO (S3) service

9× settings in .env

UPSTASH_REDIS_REST_URL
UPSTASH_REDIS_REST_TOKENsecret
CRON_SECRETsecret
STATUS_WEBSITE_URL
STATUS_API_URL
STATUS_SHARING_URL
STATUS_STORAGE_URL
STATUS_MEDIA_URL
STATUS_RENDER_URL

Featured in Zain Finds

See the poster ↗Wow..🔥 Record locally, edit with backgrounds, zooms, trimming, captions, and export cont

Share this manual

Is this your repo?

Add a badge to your README so newcomers find these steps.

[![Setup manual](https://gitmanual.com/CapSoftware/Cap/badge.svg)](https://gitmanual.com/CapSoftware/Cap)

Good to know

Monorepo (workspaces) — install from the repo root.
Cargo workspace — pick a crate with cargo run -p <name>.
Has AGENTS.md — instructions for coding agents. You can open Claude Code (or another agent) in the cloned folder and ask it to do the setup for you.
Nested projects: .agents/skills/building/package.json, apps/chrome-extension/package.json, apps/cli/Cargo.toml, apps/cli/skill/cap-demo/package.json and 11 more

package.json scripts (45)

builddotenv -e .env -- turbo run build
build:webturbo run build:web
build:web:dockerbun run --filter=@cap/web build:docker
cap-setupdotenv -e .env -- node scripts/setup.js
analytics:migrate-dubdotenv -e .env -- node scripts/analytics/migrate-dub-to-tinybird.js --dry-run
analytics:migrate-dub:applydotenv -e .env -- node scripts/analytics/migrate-dub-to-tinybird.js --apply
analytics:posthog-growthdotenv -e .env -- node scripts/analytics/posthog-growth-audit.mjs
analytics:setupdotenv -e .env -- node scripts/analytics/setup-analytics.js
analytics:checkdotenv -e .env -- node scripts/analytics/check-analytics.js
analytics:delete-alldotenv -e .env -- node scripts/analytics/delete-all-data.js
analytics:populate-testdotenv -e .env -- node scripts/analytics/populate-test-data.js
db:generatedotenv -e .env -- bun run --filter @cap/database db:generate
db:pushdotenv -e .env -- bun run --filter @cap/database db:push
db:studiodotenv -e .env -- bun run --filter @cap/database db:studio
devbun run docker:up && trap 'bun run docker:stop' EXIT && dotenv -e .env -- turbo run dev --filter=!@cap/chrome-extension --filter=!@cap/status --env-mode=loose --ui tui
dev:desktopbun run --cwd apps/desktop-gpui dev
dev:extensionbun run docker:up && trap 'bun run docker:stop' EXIT && dotenv -e .env -- turbo run dev --filter=@cap/web --filter=@cap/chrome-extension --env-mode=loose --ui tui
dev:manualbun run docker:up && trap 'bun run docker:stop' EXIT && dotenv -e .env -- turbo run dev --filter=!@cap/chrome-extension --filter=!@cap/status --concurrency 1
dev:webbun run dev --filter=!@cap/desktop
dev:windowscmd /d /c "scripts\\dev-windows.cmd"
docker:cleanturbo run docker:clean
docker:stopturbo run docker:stop
docker:upturbo run docker:up
formatbun run biome check --write
lintbun run biome lint

Files we read (13)

.github/workflows/arch-package.yml

.github/workflows/ci.yml

.github/workflows/docker-build-media-server.yml

.github/workflows/docker-build-web.yml

.github/workflows/sync-tests.yml

.github/workflows/test-self-hosting.yml

CONTRIBUTING.md

Cargo.toml

README.md

apps/status/.env.example

docker-compose.yml

package.json

rust-toolchain.toml

Branch main · 4,942 files in the repo