Skip to content

Installation and Setup

CyberGems edited this page Oct 2, 2026 · 15 revisions

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.4.0. For the recommended installer, download CyberFiles_0.4.0_x64-setup.exe. For the portable edition, download CyberFiles_0.4.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. 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.

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:3001 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.

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