Skip to content
PerkyZZ999Public

About

A fast, keyboard-friendly file manager for KDE Plasma on Wayland, written in Rust.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

Rustphin logo: a charcoal folder held by two red crab claws

Rustphin

A fast, keyboard-friendly file manager for KDE Plasma on Wayland, written in Rust.

A re-architecture of KDE's Dolphin with a dark frosted-glass look, place groups, a command palette and safe batch rename.

Version 0.1.0 Licence: GPL-3.0-or-later Rust 1.100+ KDE Plasma 6 · Wayland

Rustphin showing a Pictures folder in the icons view, with photo thumbnails and two photos selected; on the left the places panel lists the usual folders and the drives with their free space

Status: 0.1.0, the first release. Everything below is implemented and tested, and the maintainer uses Rustphin as their everyday file manager. Expect rough edges: see what is still open before relying on it for important work.

Why Rustphin

  • Fast with huge folders. A folder of 500,000 files shows its first entries in well under 200 ms, re-sorts in under half a second and scrolls at 60 frames per second. Listing, sorting, thumbnails and file operations never run on the interface thread.
  • Safe with your files. Every change goes through one operation engine: copies are written under a temporary name and only then renamed into place, nothing is overwritten unless you say so, Delete means the trash, and most operations can be undone.
  • Built for the keyboard. Dolphin's shortcuts where Dolphin has them, plus a command palette (Ctrl+Shift+P) that reaches every action, place, tab and recent folder by a few typed letters.
  • At home on Plasma. It reads and writes KDE's own places, uses your icon theme and the shared thumbnail cache, answers "Show in folder" from other applications, and blurs the desktop behind its window through KWin.

Features

Browsing

  • Details, icons and compact views, with zoom, sorting by any column and folders first
  • Tabs (reopen a closed one with Ctrl+Shift+T) and a split view to work in two folders side by side
  • Live updates as files change on disk, a filter bar (Ctrl+I), hidden files on demand and type-to-jump
  • Breadcrumbs that turn into an editable location field (Ctrl+L)

Places

  • KDE's places, shared with Dolphin, plus place groups of your own to organise them; fold a group to tidy the panel
  • Drives and removable media with their free space, drawn as bars, compact lines or rings (your choice); removable drives in their own group with Mount and Eject on the row, and a drive's Properties with a ring of used space
  • Separators between places, wherever you want them
  • Remote folders (sftp://, smb://…) through KDE's kio-fuse

Files

  • Copy, move, rename, duplicate, new folder and new file from templates, drag and drop and the clipboard, with Dolphin and other applications
  • Conflicts asked one by one or for all at once; failures can be retried or skipped
  • Trash with restore, and undo for most operations (Ctrl+Z)
  • Batch rename with find and replace (regular expressions too), patterns with counters, or a change of case, and a preview of every new name before anything changes. An interrupted batch can be put back exactly.
  • Compress and extract: ZIP, TAR (gzip, bzip2, xz, zstd) and 7Z built in; RAR, ISO, CAB, CPIO, DEB, RPM and more read through libarchive, with 7-Zip as the fallback for encrypted archives
  • Properties with permissions you can change, Open with, and an administrator mode for system folders through KDE's own kio-admin helper

Desktop

  • Set as your default file manager; other applications' "Show in folder" opens Rustphin with the file selected
  • Keeps running in the background after its last window closes, so the next window opens instantly (optional)
  • A Settings window you can move, resize and search: start-up, appearance, views, a toolbar you arrange yourself, places, confirmations and shortcuts
  • New windows open at the size you last gave one
  • A transfer line with speed and time left, and a Details window with a card and speed graph for each running copy or move

The command palette open over a folder, listing the view commands that match "view" with their shortcuts
The command palette: every action, place, tab and recent folder, a few letters away.

The batch rename dialog renaming five photos with the pattern "Dusk ##.jpg"; the preview lists each current name beside its new name, Dusk 01.jpg to Dusk 05.jpg
Batch rename: every new name is previewed before anything changes.

The Settings window on its Places page: switches for the Devices and Remote sections, the hidden places choice, the drive style (Bars, Compact or Rings) and the panel width
Settings: every page searchable, every change applied at once.

The places panel's drives in the three styles side by side: bars with free space and filesystem, compact lines with a small bar and the percentage used, and rings of used space around each drive's icon
Drives three ways: bars (the default), compact or rings.

The screenshots show the opaque theme, with made-up drives from a test service. On the desktop, the window's background is frosted glass over whatever is behind it.

Requirements

Rustphin runs on Linux with KDE Plasma 6 on Wayland. It does not support X11, other desktops' compositors, macOS or Windows.

Packages (Arch Linux names)
Required qt6-base, qt6-declarative, qt6-wayland, qt6-svg, kwindowsystem (KF6), libarchive
Optional 7zip or unrar for encrypted RAR and 7Z, kio-fuse for remote folders, kio-admin for administrator mode

To build it you also need Rust 1.100 or newer (through rustup), a C++ compiler, and the development files of the packages above, with qmake6 on your PATH.

Building and installing

git clone https://github.com/PerkyZZ999/Rustphin.git
cd Rustphin
cargo build --release --locked --package rustphin

The binary is target/release/rustphin. Try it straight away:

target/release/rustphin ~/Documents

To install it for your user, with its menu entry and icons:

install -Dm755 target/release/rustphin ~/.local/bin/rustphin
install -Dm644 assets/rustphin.desktop ~/.local/share/applications/rustphin.desktop
cp -r assets/icons/hicolor ~/.local/share/icons/
install -Dm644 assets/rustphin.svg ~/.local/share/icons/hicolor/scalable/apps/rustphin.svg

~/.local/bin must be on your PATH. To make Rustphin the default file manager, choose it in System Settings › Default Applications › File Manager.

Rustphin keeps running after its last window closes. After installing a new build, run rustphin --quit once so the next launch uses it.

Using Rustphin

Several folders, or file:// addresses, open as tabs; a path that names a file opens its folder with the file selected:

rustphin ~/Downloads ~/Pictures

A few keys worth knowing:

Keys Action
Ctrl+Shift+P Command palette: actions, places, tabs and recent folders
Ctrl+L Type a location
F3 Split view; Shift+F5 / Shift+F6 copy or move to the other side
F2 Rename; with several files selected, batch rename
Ctrl+1 2 3 Icons, compact or details view
Ctrl+Shift+D Add the current folder to the places
Ctrl+Z Undo

Every shortcut, compared with Dolphin's, is listed in docs/project/KEYBOARD.md.

If a batch rename was ever interrupted, open the folder, press Ctrl+Shift+P and run Recover original names after interruption. Rustphin checks the record it keeps and puts every name back; if anything looks wrong it stops and keeps the record, because the staged files may hold the only copy of an original.

Set RUSTPHIN_OPAQUE=1 to turn off translucency, and RUSTPHIN_LOG=debug for detailed logs on standard error.

Privacy

Rustphin makes no network connections of its own and collects nothing. It saves its settings, tabs, place groups and recent folders under your home folder; docs/project/PRIVACY.md lists every file it writes and how to clear them.

Status and roadmap

Version 0.1.0 covers browsing, tabs, split view, places, place groups and devices, file operations with undo, trash, drag and drop, thumbnails, the command palette, batch rename, compress and extract, properties, settings, administrator mode and desktop integration.

Next: 0.2.0, "Daily driver"

  • Fixes, hardening and improvements, including the checks that need real hardware (USB drives, the frosted glass on a real desktop) and a two-week trial as the maintainer's only file manager.
  • An Arch Linux package (PKGBUILD) in the repository.
  • KDE's service menus (the extra actions other applications add to Dolphin's context menu) in Rustphin's context menu.
  • Quick preview: Space shows a large preview of the file without opening an application.

Later: search (names, then contents through Baloo), an information panel, tags and ratings, translations, a light theme, browsing inside archives.

The full plan is in docs/project/ROADMAP.md; the current state and open items in docs/project/STATE.md.

How it is built

Rustphin is a Cargo workspace of four layers, each depending only on the ones below it:

Crate What it holds
rustphin-core Folder listing and sorting, selection, history, the file operation engine with undo, batch rename and archives. No user interface.
rustphin-platform The desktop: clipboard, devices, trash, thumbnails, places, MIME types and icons, D-Bus services, libarchive.
rustphin-view Interface logic without any toolkit: commands and keys, menus, panes, tabs, places panel, settings, design tokens.
rustphin The application: Qt 6 Quick and QML through cxx-qt, and a small C++ shell.

Almost all behaviour lives in the first three crates, where it is tested without a display: more than 1,000 tests, fault injection for every file operation, property tests, fuzzing of the parsers and mutation testing. The design is in docs/project/ARCHITECTURE.md, the decisions behind it in docs/project/DECISIONS.md, and the visual design in docs/DESIGN.md.

Contributing

Issues and pull requests are welcome. Before sending a change:

cargo fmt --all
cargo clippy --workspace --all-targets -- -D warnings
cargo nextest run --workspace     # or: cargo test --workspace

The maintainer's full gate, rust-tc doctor, also runs cargo-deny, cargo-shear, the layering check, the minimum Rust version and the QML linter; its recipes are in the justfile. AGENTS.md describes the project's rules: file names are bytes, every file change goes through the operation engine, no work on the interface thread, and a failing test before every bug fix.

Licence and credits

Rustphin is free software under the GNU General Public License v3.0 or later (LICENSE). Every dependency's licence is checked against deny.toml.

It follows the behaviour of Dolphin and works alongside KDE's own services. It bundles Lucide icons (ISC, LICENSE-LUCIDE) and the typefaces Inter, Space Grotesk and JetBrains Mono (SIL Open Font License, crates/rustphin/fonts).

About

A fast, keyboard-friendly file manager for KDE Plasma on Wayland, written in Rust.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages