Skip to content

docs: Add macOS screen recording permission requirement to record action docs #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
promptless wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Add macOS screen recording permission requirement to record action docs #16

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions fern/pages/docs/actions/record.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ The `record` action starts recording the browser viewport as a video file (MP4,

*Note: Recording is currently only supported in visible Chrome browsers.*

*Note: On macOS, Chrome needs screen recording permission. If recording fails, enable Chrome in **System Settings** (or **System Preferences** on older versions) > **Privacy & Security** > **Screen Recording**.*
Copy link
Contributor Author

@promptless promptless bot Mar 1, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Citation: Based on the error handling added in src/core/tests/startRecording.ts which now provides a clear error message when recording fails on macOS due to missing screen recording permissions.
View source


You can specify the recording action in several ways:

- **Boolean Shorthand:** Set `record: true` to start recording with default settings (usually saved as `record_<timestamp>.mp4` in the output directory).
Expand Down