CalmHands App Icon

Documentation

Everything you need to know about installing, configuring, and using CalmHands effectively.

Privacy & Security

Privacy First: CalmHands processes all data locally on your device.

Local Processing

All camera data is processed locally using Apple's Vision framework. An internet connection is not required, as no data is transmitted or stored externally.

Data Storage

Only detection statistics (dates/counts) and app settings are stored locally. No images or personal data are saved.

Permissions

CalmHands only requests camera access (required) and optional login items for auto-start.

Transparency: Review the complete source code on GitHub to verify these privacy claims.

Installation

System Requirements

  • macOS: 10.15 (Catalina) or later
  • Camera: Built-in or external camera
  • RAM: At least 4GB recommended (8GB+ for optimal performance)
  • Storage: ~50MB for the app
  • Internet: Optional, only needed for updates

Download & Install

  1. Download the latest release from the GitHub Releases page
  2. Extract the downloaded `.zip` or `.tar.gz` file
  3. Drag CalmHands to your Applications folder
  4. Launch CalmHands from Applications or Spotlight
  5. Grant camera permissions when prompted
Security Note: On first launch, macOS may show a security warning since the app isn't notarized. Go to System Preferences > Security & Privacy > General and click "Open Anyway" to allow CalmHands to run.

Usage

First Launch

CalmHands will request camera permissions on first launch. Grant access to enable nail biting detection.

Starting Tracking

  1. Open the dashboard ( + D or click menu bar icon)
  2. Click "Start Tracking" button
  3. Position yourself so your face is visible to the camera

Menu Bar Controls

Right-click the menu bar icon for quick access to start/stop tracking, show dashboard, or quit the app.

Detection Process

CalmHands uses Apple's Vision framework to detect nail biting gestures. When detected, a gentle full-screen overlay appears with multiple dismissal options (click, auto-dismiss, or detection-based).

Menu Bar Icon States

  • Empty hand with line through: Tracking not active
  • Filled hand with line through: Tracking active but face not detected
  • Filled hand: Tracking active and face detected

Settings & Configuration

App Behavior

  • Start on Login: Launch CalmHands automatically when you log in
  • Start Tracking on Launch: Begin monitoring immediately when the app starts
  • Hide Dock Icon: Keep CalmHands running only in the menu bar (default: off)

Camera Settings

  • Camera Selection: Choose between built-in and external cameras

Detection Settings

  • Sensitivity: Adjust detection sensitivity (1-5 scale, default: 3)
  • Processing Rate: Control how often camera is analyzed
  • Auto Optimize: Automatically reduce processing when on battery power

Overlay Settings

  • Enable Overlays: Turn overlay reminders on/off
  • Dismissal Mode: Choose how overlays are dismissed:
    • Dismiss when no nail biting detected: Auto-dismiss when gesture stops
    • Auto-dismiss after 5 seconds: Timeout-based dismissal
    • Manual dismissal only: Must click to dismiss

Troubleshooting

Camera not detected

Check camera permissions in System Preferences > Security & Privacy > Camera. Restart CalmHands if needed.

High CPU usage

Enable "Auto Optimize Processing Rate" in settings and lower detection sensitivity.

False positives or missing detections

Adjust detection sensitivity (1-5 scale) and ensure good lighting conditions with face clearly visible to camera.

Frequently Asked Questions

Is CalmHands free?

Yes, CalmHands is completely free and open source. You can download, use, and modify it without any cost. The source code is available on GitHub.

Can I use CalmHands while using other camera apps?

Generally no, as macOS only allows one app to access the camera at a time. Close other camera apps before using CalmHands.

How accurate is the detection?

Detection accuracy depends on lighting conditions, camera positioning, and sensitivity settings. The app uses Apple's Vision framework with smart filtering to minimize false positives while maintaining sensitivity to actual nail biting gestures.

Can I customize the overlay appearance?

Currently, overlay customization is limited, but you can adjust dismissal behavior (auto-dismiss, manual, or detection-based) and enable/disable overlays in the settings.

Does CalmHands work in the background?

Yes, CalmHands can run in the background and continue monitoring when the dashboard is closed, as long as it's running in the menu bar. It will show overlay alerts even when the dashboard isn't visible.

How do I update CalmHands?

CalmHands includes an automatic update checker that verifies releases from the official GitHub repository. You can also manually check for updates in the dashboard or download new releases from GitHub.

Does CalmHands drain my battery?

CalmHands includes smart power management that automatically reduces processing when on battery power. You can also manually adjust processing rates and sensitivity to optimize battery usage.

What data does CalmHands collect?

CalmHands collects no personal data. It only stores detection statistics (dates and counts) locally on your device, plus your app settings. No images, videos, or personal information are stored or transmitted.

What if the detection isn't working well?

Try adjusting the sensitivity setting, improving lighting conditions, ensuring your face is clearly visible to the camera, and checking that hands are in the camera's field of view. The app works best with good lighting and clear camera positioning.