English View source
Installation and Setup
English · Español
Installation & Setup
This guide covers installing CyberClock, building from source, and keeping it up to date.
System Requirements
| Requirement | Minimum |
|---|---|
| OS | Windows 10 (64-bit) or later |
| Architecture | x64 |
| Runtime | None (Tauri bundles all dependencies) |
| Disk space | ~100 MB |
| RAM | 2 GB |
Installation Methods
Installer (Recommended)
- Download the latest installer from Releases
- Run the
.exeinstaller - Follow the setup wizard
- Launch CyberClock
What the Installer Does
- Installs the application
- Creates Start Menu shortcuts
- Creates Desktop shortcut (optional)
- Offers to start with Windows
Portable Package
- Download the portable ZIP from the latest release
- Extract it to any folder and run
CyberClock.exe - Settings and imported alarm sounds are stored in the
data/folder beside the executable - Portable copies do not create shortcuts or auto-start entries; update them by downloading the next portable ZIP
Windows SmartScreen
Windows may show a SmartScreen warning the first time you run the CyberClock installer; this is expected until Windows builds enough reputation for the file.
To continue:
- Click More info.
- Click Run anyway.
Building from Source
Prerequisites
| Tool | Version |
|---|---|
| Node.js | Latest LTS |
| Rust | 1.77+ |
| Tauri CLI | Latest |
Setup
# Clone the repository
git clone https://github.com/CyberGems/CyberClock.git
cd CyberClock
# Install dependencies
npm install
# Run in development mode
npm run dev
Build for Production
# Build Tauri app with installer
npm run build
The built installer will be in:
src-tauri/target/release/bundle/nsis/
Auto-Start
CyberClock can launch automatically when you sign in:
Enable/Disable
- Settings → General → Auto-start with Windows
- Or: Windows Settings → Apps → Startup → Toggle CyberClock
Start in Mini Mode
- Settings → General → Start in Mini Mode
- App starts straight into the compact clock instead of the full window
Auto-Update
How It Works
- CyberClock checks GitHub Releases on startup
- When an update is available, a notification appears
- Download with progress indicator
- Installer launches when complete
Manual Update
- Go to Settings → About → Check for Updates
- Or: Download the latest installer from releases
System Tray
Tray Features
- Minimize to tray
- Custom HTML popup menu
- Quick access to all modules
Tray Menu
A left click on the tray icon brings the clock forward. It never hides it. An unlocked Mini Mode clock that is on another monitor moves next to that icon. Right-click the icon for the menu:
| Action | Description |
|---|---|
| On screen · Full Mode (or Mini Mode, or Hidden) | Status only. It says whether the clock is on screen and which mode it is in |
| Full Mode and Mini Mode | Both stay listed. The current one is marked. Choosing the other switches mode |
| Hide Clock / Show Clock | Hides or shows the clock. The same shortcut as Alt+Shift+C |
| New Timer | Open a floating timer |
| New Stopwatch | Open a floating stopwatch |
| New Calendar | Open a floating calendar |
| New Analog Clock | Open a floating analog clock |
| New Relax | Open a floating relaxation session |
| New Alarm | Open the alarm designer in Full Mode |
| Settings... | Open settings |
| Zoom | Mini clock zoom, in its own group |
| Click-through | Mouse clicks pass through the mini clock and floating widgets |
| Exit | Close CyberClock |
Data Location
Default Locations
| Data | Location |
|---|---|
| Settings | %APPDATA%\CyberClock\ |
| Sounds | assets/sounds/ (bundled) |
Uninstallation
Standard Uninstall
- Windows Settings → Apps → Installed Apps
- Find CyberClock → Click Uninstall
What Gets Removed
- Program files
- Start Menu shortcuts
- Auto-start entry
What Is Kept
- Settings (in
%APPDATA%\CyberClock)
⚠️ To remove all data, manually delete
%APPDATA%\CyberClockafter uninstalling.