\-f, --fps <FLOAT>
): frames per second for continuous recording
1.0
(non-macos), 0.5
(macos)1 FPS ≈ 30 GB/month
, 5 FPS ≈ 150 GB/month
\-p, --port <INT>
): port to run the server on
3030
--data-dir <PATH>
): data directory
$HOME/.screenpipe
--debug
): enable debug logging
false
\-d, --audio-chunk-duration <INT>
): audio chunk duration in seconds
30
--disable-audio
): disable audio recording
false
\-i, --audio-device <STRING>
): audio devices to use (can specify multiple)\-r, --realtime-audio-device <STRING>
): devices for realtime transcription--list-audio-devices
): list available audio devices\-a, --audio-transcription-engine <ENGINE>
): transcription engine
deepgram
: cloud-based, high quality (free tier available)whisper-tiny
: local, lightweight, privacy-focusedwhisper-large
: local, higher quality than tinywhisper-large-v3-turbo
: local, highest qualitywhisper-large-v3-turbo
--enable-realtime-audio-transcription
): enable realtime transcription
false
--disable-vision
): disable vision recording
false
--list-monitors
): list available monitors\-m, --monitor-id <INT>
): monitor IDs to record (can specify multiple)--ignored-windows <STRING>
): windows to ignore by title
--ignored-windows "Spotify" --ignored-windows "Chrome"
--included-windows <STRING>
): windows to include by title
--included-windows "Code" --included-windows "Terminal"
--video-chunk-duration <INT>
): video chunk duration in seconds
60
\-o, --ocr-engine <ENGINE>
): OCR engine selection
apple-native
: default for macoswindows-native
: default for windowstesseract
: default for linuxunstructured
: cloud-based (free tier available)custom
: configurable via SCREENPIPE_CUSTOM_OCR_CONFIG
\-l, --language <LANG>
): languages to support (can specify multiple)--use-pii-removal
): enable PII removal from OCR text
false
--vad-engine <ENGINE>
): voice activity detection engine
silero
, webrtc
silero
--vad-sensitivity <LEVEL>
): VAD sensitivity level
low
, medium
, high
high
--enable-llm
): enable local LLM API
false
--enable-ui-monitoring
): enable UI monitoring (macos only)
false
--enable-frame-cache
): enable experimental video frame cache
false
--capture-unfocused-windows
): capture unfocused windows
false
--enable-realtime-audio-transcription
): enable realtime transcription
false
--realtime-audio-device
screenpipe
CLI supports generating shell completions for popular shells. Follow the steps below to enable autocompletion for your shell:
.bashrc
profile:.zshrc
profile:\~/.config/fish/conf.d/screenpipe.fish
and add this line to it:\~/.config/powershell/Microsoft.PowerShell_profile.ps1
%userprofile%\\Documents\\WindowsPowerShell\\Microsoft.PowerShell_profile.ps1
Powershell 5%userprofile%\\Documents\\PowerShell\\Microsoft.PowerShell_profile.ps1
Powershell 6+