EyeZen DOCS
Open source · local-first · v1.2.0 documentation

A calmer workspace.
Your settings, your device.

The complete EyeZen guide: features, browser and desktop editions, ten appearance themes, workspace profiles, gentle routines, supported screen-tint overlays, privacy, accessibility and release downloads.

No account. No analytics. Browser settings are stored on your device. The web edition cannot tint other apps or change monitor hardware.

At a glance
One project, two experiences.

Personalize the web app in your browser, or install EyeZen on Windows, macOS or Linux for the desktop features supported by your session.

10Interface themes
9Starter profiles
100%Local settings
MPL-2.0Open-source license
01 / THE PROJECT

What is EyeZen?

EyeZen is a local-first, open-source utility for customizing workspace appearance, organizing comfort profiles and managing screen-time routines. The desktop app uses Rust and Tauri 2; its interface and web edition use React, TypeScript and Vite.

Scope matters: The desktop app can display opt-in, transparent tint overlays across enumerated monitors on supported sessions. A browser tab cannot modify other apps, system color profiles, physical backlights or operating-system night modes. Visual tinting is not hardware color-temperature calibration.
02 / QUICK START

Get started in minutes

  1. Open EyeZen Web for immediate use, or download the desktop installer for your supported OS.
  2. Choose Light, Dark or System theme in onboarding. You can revisit it later.
  3. Switch among the nine built-in profiles, or create your own. Change appearance, comfort preferences and reminder settings.
  4. Optionally add a weekday/time schedule, set quiet hours and enable gentle reminders.
  5. Use Settings → Export backup to save a portable JSON file before switching browsers/devices.
  6. On desktop only, use Eye Comfort to enable the click-through screen tint if your session supports it. The tray contains an emergency disable control.

The web edition stores settings in this browser's local storage. They will not automatically sync to other browsers or the desktop app.

03 / FEATURE CATALOG

Every main feature

Dashboard

Current profile, appearance, automation status, break assistant, quick profile switching and warmth preferences.

Web + Desktop

Theme Studio

Ten built-in themes, system preference detection, accent color customization, text scale and reduced-motion control.

Web + Desktop

Profiles

Nine starter presets; create, rename, select, edit, remove, import and export personalized workspaces.

Web + Desktop

Automation

Local day-of-week schedules, overnight time ranges, rule priorities and manual override while the application is running.

Web + Desktop

Break Assistant

Optional timed reminders, quiet hours, in-app pause countdown, finish early, dismiss, pause and permission-based notifications.

Web + Desktop

Local Backups

Full settings JSON export/import and versioned profile import/export with validation and safety limits.

Web + Desktop

Screen Comfort

Warmth/intensity preferences. Desktop-only click-through visual overlays across supported detected monitors, including a tray emergency stop.

Desktop tint only

Displays & Capabilities

Live desktop monitor enumeration and honest supported/unsupported feature status. Browser edition reports its unavailable system APIs.

Desktop enumeration only

Accessibility

Semantic labels, keyboard-oriented controls, optional reduced motion, high contrast palette and configurable text size.

Web + Desktop

Tray & Shortcut

Desktop tray Open/Quit/Disable Comfort actions and optional session-based global dashboard shortcut, subject to OS support.

Desktop only
04 / CAPABILITY COMPARISON

What works where?

FeatureWeb browserWindows/macOS desktopLinux desktop
Themes & appearanceYesYesYes
Persistent settingsBrowser local storageLocal config JSONLocal config JSON
Profiles, backup/importYesYesYes
Schedules / remindersWhile tab activeWhile app activeWhile app active
NotificationPermission + browser supportPermission + OS supportDesktop environment
Screen-wide visual tintNoSupported sessions; hardware testing neededExperimental X11; no Wayland
Monitor enumerationNoVia Tauri OS APIEnvironment-dependent
Tray and global shortcutsNoOS-dependentEnvironment-dependent
Native backlight / Night Light / ICC / HDRNoNoNo
Account or cloud requiredNoNoNo
05 / BROWSER EDITION

A useful web edition, with clear boundaries.

EyeZen v1.2.0 brings persistent browser-local preferences. You can change themes and profiles, configure reminders/schedules, use the in-app pause countdown, create backups and resume on the same browser later. All of this happens locally in your tab.

The site is delivered as static files using GitHub Pages. It has no application database, authentication server, telemetry endpoint or cloud synchronization. Clearing site data, private browsing or switching browser profiles can remove saved settings: export your JSON backup first.

Browsers cannot tint other apps, obtain your monitor layout for overlays, change system brightness, guarantee reminders when closed, or register a global OS keyboard shortcut. Permissions for notifications must be requested with a user action.
Open EyeZen Web ↗
06 / DESKTOP EDITION

For the full desktop environment.

The Tauri app adds persistent local JSON configuration, native monitor capability reports, opt-in visual tint windows, the system tray and optional global shortcut handling. It uses the same React interface, backed by Rust commands.

On supported Windows and macOS sessions, EyeZen can create transparent, click-through overlay windows per enumerated display. Linux X11 behavior is experimental and compositor-dependent; Linux Wayland is not supported. Use the tray’s Disable screen comfort emergency action if needed. Tint windows do not adjust physical backlight or calibrated display controls.

Get the latest verified release assets; unsigned Windows x64 MSI, macOS Apple Silicon DMG and Linux x86-64 DEB/RPM are the CI packaging targets.

07 / PERSONALIZATION

Themes & workspace profiles

Ten themes: Light, Dark, System, Warm Dark, Warm Light, Sepia Reading, Midnight, AMOLED-Inspired, High Contrast and Grayscale.

Nine starter profiles: Coding, Reading, Office Work, General Productivity, Gaming, Video Editing, Photo Editing, Evening Comfort and Accessibility. Each profile may include its own theme, comfort preference and reminder settings.

Saved profiles can be exported as JSON and imported after schema validation. The full settings backup also preserves schedules, active profile, accent color and accessibility preferences.

08 / ROUTINES

Schedule rules & mindful pauses

Schedules select profiles based on computer-local time, chosen weekdays and priority. Overnight rules (for example, 22:00–06:00) are supported. A manual override stops automatic switching until you release it. The scheduler runs only when the app or browser tab is active.

The optional Break Assistant supports intervals from 5 to 240 minutes, suggested pauses from 10 to 600 seconds, start/end quiet hours, pausing, dismissal and session-only counters. OS/browser notifications are permission-dependent and may be delayed or unavailable.

09 / DATA CONTROL

Local-first privacy & backups

  • No registration or sign-in for local functionality, no telemetry pipeline and no cloud synchronization.
  • Web: JSON settings live in origin-scoped `localStorage` on your device, not a GitHub Pages backend. Private/incognito browsing and storage settings may restrict persistence.
  • Desktop: configuration stored in the OS Tauri app configuration directory in `settings.json`; write validation and recovery preserve a local backup where possible.
  • Backup import validates schema, rule times, weekdays, identifiers and ranges; input size is limited to 128 KB.
  • Use Settings → Export backup to move data between the web and desktop editions manually. Review imported files before use.
Privacy caveat: while this static website does not implement its own tracking, GitHub Pages hosting and the user's browser/network infrastructure may produce normal service access logs. Do not store secrets in preferences.
10 / INCLUSIVE DESIGN

Accessibility and input

EyeZen includes high-contrast and reduced-motion choices, adjustable interface text scale, labeled form controls, focus states, and native HTML controls where practical. Assistive-technology compatibility is an ongoing testing goal, not a certified accessibility guarantee.

Web users should use standard browser zoom, keyboard navigation, reduced-motion OS settings and screen-reader controls as needed. No feature promises medical benefits or prevention of eye disease.

11 / INSTALLATION

Download or build from source

To install, open the latest release page, choose an installer matching your architecture, compare against the release's SHA256SUMS.txt if supplied, then follow the OS prompts. CI packages are unsigned and may cause operating-system warnings. Never disable system security protections just to run an unverified binary.

Build from source

git clone https://github.com/sanskarIN/EyeZen.git
cd EyeZen
npm ci
npm run lint
npm run typecheck
npm run test
npm run build
# Desktop builds require Rust, native prerequisites and Tauri:
npm run tauri dev

Rust toolchain and native libraries vary by platform. Read README for prerequisites and testing guidance.

12 / OPEN SOURCE

Architecture & contribution

React + TypeScript + Vite power the shared interface. In desktop builds, Tauri 2 and Rust provide configuration storage, schedule matching, monitor enumeration, transparency overlays and plugins for the tray, notifications and global shortcuts. The web edition replaces native persistence with validated browser local storage.

Automated CI checks include ESLint, TypeScript, Vitest, Rust formatting, Clippy, Cargo tests and unsigned installers. Pull requests and bug reports are welcome. The code is licensed under Mozilla Public License 2.0; third-party dependencies retain their licenses.

Source code · Issues · Contributing · Architecture · Security

13 / HONEST LIMITS

Known limitations

  • Visual desktop tint does not modify physical brightness, gamma ramps, OS night modes, HDR or calibrated ICC profiles; fullscreen/secure windows can bypass overlays.
  • Linux Wayland general overlays are unsupported; X11 is experimental and subject to compositor behavior.
  • Browser pages cannot control other windows, monitor hardware, tray or global shortcuts.
  • Automatic profile switching and reminders require an active running process/tab; background behavior cannot be guaranteed.
  • Independent physical multi-display testing and full assistive-technology certification are not yet documented.
  • Desktop releases are unsigned; macOS transparency uses a Tauri private API that restricts App Store distribution.
14 / SUPPORT

Frequently asked questions

Do themes affect all applications on my computer?

No. Interface themes style EyeZen only. On a supported desktop, separately enabling Screen Comfort may display a visual tint over normal desktop windows. Web themes never affect other websites or apps.

Can I use EyeZen completely offline?

The installed desktop application uses local settings without a cloud service. The web app requires a network connection to load the site initially unless separately cached by the browser; local preference changes themselves do not require a backend.

Will my data sync across devices?

No. EyeZen has no cloud sync. Export a JSON backup and import it on another installation or browser to move your settings.

Why doesn't the overlay work on Linux Wayland?

Wayland intentionally limits unprivileged apps from placing global always-on-top windows above other applications. EyeZen does not bypass those limits.

Can EyeZen cure or prevent eye strain?

No. EyeZen is a personalization and reminder tool, not a medical device. It makes no prevention or treatment claims.

Where do I report a bug or request a feature?

Open a GitHub issue with your OS, browser/session type, version and reproduction steps. Do not include private data or credentials.

Try the web edition ↗ Latest desktop release ↗