Installation

There are no prebuilt downloads yet, so you build RustZ from source. It takes a few minutes once; after that it is an ordinary application.

Requirements

• Rust 1.95 or newer — needed by eframe 0.36, which the desktop app uses. The command-line tool alone builds with 1.85. Install Rust with rustup.
• macOS 11 or later, Windows 10 or later, or Linux with an X11 or Wayland desktop.
• The app draws with the GPU (Metal, Direct3D, Vulkan or OpenGL), which any ordinary computer has.

Build from source

cargo build --release
cargo test --workspace     # optional

The results are in target/release/: rustz (the app) and rustz-cli (the command-line tool). Dictionaries and tables are compiled into the programs; there are no data files to ship.

macOS: build an app and keep it in the Dock

sh tools/bundle_macos.sh

This creates target/RustZ.app, with its icon and with the command-line tool inside. Drag it to Applications, open it, then right-click its Dock icon → Options → Keep in Dock.

To put the command-line tool on your PATH:

ln -s /Applications/RustZ.app/Contents/MacOS/rustz-cli /usr/local/bin/rustz-cli

Signing

The script signs the app ad hoc, which is enough to run it on your own Mac. To give it to other Macs you need to sign it with an Apple Developer ID and have it notarized; the script does not do that.

Windows

cargo build --release

target\release\rustz.exe is the app — the release build opens no console window — and rustz-cli.exe is the command-line tool; put it in a folder on your PATH. Once rustz.exe is running, right-click its taskbar icon → Pin to taskbar.

Linux

Building needs no extra development packages. At run time RustZ uses what a desktop already has: X11 or Wayland, the XDG Desktop Portal for file dialogs, and the StatusNotifierItem D-Bus interface for the tray icon.

To install for your user and add it to the application menu:

install -Dm755 target/release/rustz     ~/.local/bin/rustz
install -Dm755 target/release/rustz-cli ~/.local/bin/rustz-cli
install -Dm644 packaging/linux/rustz.desktop ~/.local/share/applications/rustz.desktop

python3 tools/make_icon.py /tmp/rustz-icons 256
install -Dm644 /tmp/rustz-icons/rustz-256.png ~/.local/share/icons/hicolor/256x256/apps/rustz.png

If you do not want the tray icon, leave it out of the build:

cargo build --release --no-default-features -p rustz-gui

Uninstall

Delete the programs (or RustZ.app). Settings and the custom dictionary live in the folder below; delete it too if you no longer need them.

Platform	Location
macOS	~/Library/Application Support/RustZ/
Windows	%APPDATA%\RustZ\
Linux	~/.config/rustz/ (or $XDG_CONFIG_HOME/rustz/)