Skip to content

Installation and Setup

CyberGems edited this page Nov 15, 2026 · 15 revisions

English · Español

Installation and Setup

CyberFiles is a Windows desktop application built with Tauri, Rust, and a web UI. Follow the official Tauri Windows prerequisites for the required Rust toolchain, Microsoft C++ build tools, and WebView2 environment.

Download and install a release

The current Windows x64 prerelease is CyberFiles v0.8.0. For the recommended installer, download CyberFiles_0.8.0_x64-setup.exe. For the portable edition, download CyberFiles_0.8.0_x64-portable.zip. The SHA256SUMS.txt asset contains checksums for both packages.

The NSIS installer offers current-user or system-wide installation. Choosing system-wide installation may require administrator approval. Setup uses the CyberFiles artwork and follows the system language, English or Spanish, without a language selector, and the final setup page offers to run CyberFiles as soon as setup finishes. If the WebView2 runtime is missing, setup downloads its bootstrapper, so an internet connection is needed during installation.

For a portable copy, extract the ZIP and run CyberFiles.exe. It stores settings and user data in the CyberFiles_Data folder beside the executable; keep that folder when moving or backing up the app. The portable profile is separate from the installed app and requires the WebView2 Evergreen Runtime.

Updates

Installed copies update themselves. CyberFiles reads the signed release manifest on start and every six hours; when a newer version exists it shows the release notes with the choice to install now, postpone, or skip that version. The installer keeps the installation type chosen during setup (current user or system-wide) and CyberFiles restarts when it finishes. The download is only installed when its signature matches the release, so a modified file is rejected.

About CyberFiles, opened from the tray menu, runs a check on demand and reports the reason when the manifest cannot be reached. The same window turns the automatic check off.

The portable edition does not update itself, because the installer does not own that folder. About CyberFiles links to the releases page instead: download the new ZIP and replace the old files, keeping the CyberFiles_Data folder beside the executable.

The manifest is published on the updater branch rather than as a latest release asset, because every 0.x release is marked as a pre-release and GitHub's releases/latest endpoint skips those.

Windows integration

Settings › General has a Windows integration section with two optional integrations. Both write per-user registry data only, so neither needs administrator approval, and both are available in the Windows desktop app only.

Open in CyberFiles context menu. Adds an Open in CyberFiles entry to the right-click menu of every folder, including the folder background inside an Explorer window. Choosing it opens that folder in a new CyberFiles tab. Turning the option off removes the entry, and uninstalling CyberFiles removes it as well. If CyberFiles is already running, using the entry brings the open window to the front; opening the folder inside the running window is planned for a future version.

Start with Windows. Launches CyberFiles automatically when you sign in, registered through the per-user Windows Run entry. When this is on, a Start minimized option appears, on by default: sign-in launches stay in the system tray instead of showing the window, while any launch you make yourself always shows the window. Turning the option off removes the Run entry, and uninstalling CyberFiles removes it as well.

Run from source

From the repository root:

npm ci
npm run dev:desktop

The desktop app starts with the This PC view. Use the native app to test drive discovery, Windows properties, the global shortcut, file browsing, file operations, and Recycle Bin behavior.

Build a debug executable

npm run build:desktop

This creates a local debug executable without packaging an installer. It is useful for development, not distribution.

Build the Windows installer

npm run build:installer

This creates the x64 NSIS installer under src-tauri/target/release/bundle/nsis. The first release build may take several minutes while Rust dependencies compile.

Build the portable package

npm run build:portable

This builds the desktop executable and packages it as a portable ZIP under src-tauri/target/release/bundle/portable.

Checks and tests

npm run lint
npm test
npm run test:native

npm test runs the TypeScript unit tests. npm run test:native runs Rust tests and should be run in the supported Windows build environment. npm run check runs the lint and frontend build checks.

Browser preview for testing only

npm run dev:vite-internal starts Vite on http://127.0.0.1:1421 for UI-only troubleshooting. The normal desktop command, npm run dev:desktop, starts Tauri and manages this server automatically. The browser preview is for development and testing only; it cannot enumerate Windows drives or use native Windows Shell, Recycle Bin, or global-shortcut features.

In a supporting browser, the preview can ask the user to select a folder using the File System Access API. Browser support is limited, the API requires a secure context and a user gesture, and access is governed by browser permissions. See MDN's showDirectoryPicker() documentation. These browser constraints do not define the capabilities of the Windows desktop app.

Uninstallation

Standard Uninstall

  1. Windows Settings → Apps → Installed Apps
  2. Find CyberFiles → Click Uninstall

The confirm page offers a Delete app data checkbox, off by default. Tick it to also remove your settings and the WebView2 profile; leave it off to keep them for a future reinstall.

The portable edition has no uninstaller. Delete the extracted folder, including CyberFiles_Data, when you no longer need it.

What Gets Removed

  • Program files
  • Start Menu and desktop shortcuts, if they were created
  • The remembered install folder (kept in the registry so a reinstall can land in the same place)
  • The Explorer Open in CyberFiles menu entry, if it was enabled
  • The start-with-Windows Run entry, if it was enabled
  • Settings and the WebView2 profile, only when Delete app data is ticked

What Is Kept

  • Settings (%APPDATA%\com.cybergems.cyberfiles) and the WebView2 profile (%LOCALAPPDATA%\com.cybergems.cyberfiles), kept by default
  • Your files: uninstalling removes only what the installer added, never your documents or folders

⚠️ To remove all data, tick Delete app data while uninstalling, or delete both folders afterwards.

Future releases

Pushing an annotated v* tag that matches the versions in package.json and src-tauri/tauri.conf.json automatically builds and publishes a release. Include a concise user-facing summary in the tag message; it becomes the release summary.

Clone this wiki locally