- xtask bundle builds lutra-cli and adds it as a Tauri external binary through a --config override (lutra.exe next to the app on Windows, Lutra.app/Contents/MacOS/lutra on macOS); prints path, version, size. - NSIS: "Add lutra to PATH" page, unticked by default, /ADDTOPATH for silent installs. Changes HKCU\Environment Path only, keeps its type, broadcasts WM_SETTINGCHANGE, records the entry; the uninstaller removes exactly that entry. A PATH too long for NSIS strings is left alone. - lutra CLI resolves a symlinked executable before looking for the app. - localStorage: the UI never used webview storage, so there is nothing to migrate; docs corrected, ESLint now bans localStorage, sessionStorage and indexedDB, with tests. - docs/install.md: CLI, PATH, macOS link step, webview folder. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
10 KiB
Installing Lutra
Status: draft, alpha installers · Last updated: 2026-11-01
Lutra's alpha comes as an installer for Windows (a setup .exe) and macOS (a .dmg). Both are not signed yet, so Windows and macOS warn before the first start; the steps below get past that once. Linux has no installer yet: build it from source (development.md).
Both installers contain the desktop app and the lutra command-line tool (lutra file.php, lutra ., lutra mcp). On Windows the setup can put lutra on your PATH; on macOS you link it once (see Using lutra from a terminal).
Building an installer
On the platform you want the installer for:
cargo xtask bundle
It builds the lutra CLI and the release app with the bundled UI, packs both, and prints the installer's path, the version and the size, for example bundle: Lutra 0.1.0-alpha: C:\…\target\release\bundle\nsis\Lutra_0.1.0-alpha_x64-setup.exe (5.4 MB). The installer is target/release/bundle/nsis/Lutra_<version>_x64-setup.exe on Windows and target/release/bundle/dmg/Lutra_<version>_aarch64.dmg on macOS. The version comes from apps/lutra-desktop/tauri.conf.json. It needs the Tauri CLI (cargo install tauri-cli --locked) and, on macOS, the Xcode Command Line Tools (macos.md).
Windows
Lutra installs for your user only: no administrator rights, no UAC prompt. It needs Microsoft Edge WebView2, which Windows 10 and 11 already have; if it is missing, the setup downloads it.
- Start
Lutra_<version>_x64-setup.exe. - Windows SmartScreen says "Windows protected your PC", because the setup is not signed. Click More info, check that the app is
Lutra_<version>_x64-setup.exeand the publisher is "Unknown publisher", then click Run anyway. If you downloaded the file with a browser, the browser may ask first whether to keep it. - The setup runs in English or German, following Windows. Click Next and keep or change the folder (default
%LOCALAPPDATA%\Lutra). - On the Command line page, tick Add lutra to PATH if you want to run
lutrain a terminal. It is off by default. Click Next, then Install. - On the last page, tick Create desktop shortcut if you want one, keep or clear Run Lutra, and click Finish. The setup closes at once; Lutra starts through Explorer a moment later.
Lutra is now in the Start menu as Lutra and in Settings → Apps → Installed apps. Installing a newer setup over it updates it in place and keeps your settings.
For scripts: Lutra_<version>_x64-setup.exe /S installs silently with both shortcuts, /P shows only the progress bar, /ADDTOPATH adds lutra to the PATH, /D=C:\path (last argument) picks the folder, /NS skips the shortcuts, /R starts Lutra afterwards.
Using lutra from a terminal
The setup installs lutra.exe next to lutra-desktop.exe in the install folder. With Add lutra to PATH ticked, the setup appends the install folder to your user PATH (HKCU\Environment, value Path; the system PATH is not touched) and tells Windows the environment changed. Terminals opened afterwards find it:
lutra src\Controller\HomeController.php:42
lutra .
lutra <file> opens the file in the running Lutra, inside the project around it (see below); if Lutra is not running, it starts it first. Without the PATH entry, call it by its full path: %LOCALAPPDATA%\Lutra\lutra.exe file.php.
The setup notes the folder it added (value PathEntry under HKCU\Software\Lutra\Lutra). Running a newer setup keeps the entry; clearing the box there removes it. The uninstaller removes exactly that entry and leaves the rest of your PATH as it was. If the folder was on your PATH before the setup ran, the setup does not add it a second time and the uninstaller leaves it alone. A user PATH too long for the setup to edit safely (about 1000 characters) is not changed; the setup says so, and you can add the folder by hand.
Opening PHP files from Explorer
The setup offers Lutra in Explorer's Open with menu for .php, .phtml, .phpt and .inc files. It does not become the default app: double-clicking a PHP file still opens whatever opened it before. To make Lutra the default, pick Open with → Choose another app → Lutra and tick Always.
A file opened this way opens in a tab, inside the project around it: the nearest folder above it that is a Git repository, else the nearest one with a composer.json, else the file's own folder. If Lutra is already running, the running window takes the file. A file outside its open project switches the project; if the open project has unsaved changes, Lutra refuses to switch and nothing is lost. The same works from a terminal: lutra-desktop.exe C:\path\to\file.php.
If the setup stops responding on the last page
Seen once, with the 0.0.0 setup on a PC with Norton 360: after Finish with "Run Lutra" ticked, the setup window stopped responding, Windows closed it ("has stopped interacting with Windows", event AppHangB1), and Lutra did not open. What we found:
- The 0.0.0 setup started Lutra with Tauri's
RunAsUserhelper, which calls ShellExecute on the setup's window thread. The newlutra-desktop.exeprocess was created suspended (one thread, wait reason "Suspended", no CPU time, no window) while the freshly written, unsigned exe was being checked, and the setup waited inside that call. When Windows ended the hanging setup, nothing resumed the process: it stayed in Task Manager as alutra-desktop.exewithout a window. - The same kind of build installed on the same PC without a hang, by hand and from a script. The stall depends on the check of a new, unknown file and could not be reproduced on demand. Norton 360 was active; its settings were not changed.
- In that run the Installed-apps entry (
HKCU\Software\Microsoft\Windows\CurrentVersion\Uninstall\Lutra) was missing andHKCU\Software\Lutra\Lutrastill pointed to an older test install, although the files,uninstall.exeand the Start-menu shortcut were written. Every later install on the same PC wrote both keys correctly; why they were missing in that one run is not known.
Since 0.1.0-alpha the finish page starts Lutra through Explorer (explorer.exe "<install folder>\lutra-desktop.exe") and returns at once, so the setup no longer waits for those checks, and a slow check delays only Lutra's start. If you still find a lutra-desktop.exe without a window after a setup, end it in Task Manager and start Lutra from the Start menu. If Lutra is missing from Installed apps, run the setup again: it writes the entry anew.
Uninstalling on Windows
Settings → Apps → Installed apps → Lutra → … → Uninstall, or run uninstall.exe in the install folder. The uninstaller removes the app and lutra.exe, its shortcuts, its Installed-apps entry, the Open with entries and the PATH entry the setup added. Your settings, recovery journal and Phpactor stay unless you tick Delete the application data.
macOS
The DMG holds the app for Apple Silicon (M1 or newer), macOS 11 or newer.
- Open
Lutra_<version>_aarch64.dmgand drag Lutra onto Applications. Eject the DMG. - The first start is blocked because the app is not signed or notarised. In Applications, right-click (or Control-click) Lutra → Open, and click Open in the dialog. On macOS 15 Sequoia and newer that dialog has no Open button: click Done, then open System Settings → Privacy & Security, scroll to "Lutra was blocked", click Open Anyway and confirm with your password.
- Alternatively, remove the quarantine flag once in Terminal and start Lutra normally:
xattr -dr com.apple.quarantine /Applications/Lutra.app
You need to do this once per installed version.
Using lutra from a terminal on macOS
The CLI is inside the app, at /Applications/Lutra.app/Contents/MacOS/lutra. Link it once into a folder on your PATH, for example:
mkdir -p ~/.local/bin
ln -sf /Applications/Lutra.app/Contents/MacOS/lutra ~/.local/bin/lutra
~/.local/bin must be on your PATH (add export PATH="$HOME/.local/bin:$PATH" to ~/.zshrc if it is not). /usr/local/bin works too, with sudo. The link follows updates, because a new version replaces the app at the same place. Remove the quarantine flag first (step 3 above), or macOS blocks the unsigned lutra binary as well. To remove it again: rm ~/.local/bin/lutra.
Opening PHP files from Finder
Lutra registers as an alternate editor for .php, .phtml, .phpt and .inc files: it appears under Open With without becoming the default. A file opens as on Windows, in the project around it.
Uninstalling on macOS
Quit Lutra and drag Lutra from Applications to the Trash. Your data stays; delete the folders below to remove it.
Where your data lives
| What | Windows | macOS |
|---|---|---|
| The app | %LOCALAPPDATA%\Lutra\ |
/Applications/Lutra.app |
Settings (settings.json), recovery journal (recovery\), downloaded Phpactor (tools\) |
%APPDATA%\com.tyrveil.lutra\ |
~/Library/Application Support/com.tyrveil.lutra/ |
| The web view's caches (no settings or other state of yours) | %LOCALAPPDATA%\com.tyrveil.lutra\ |
~/Library/WebKit/com.tyrveil.lutra/, ~/Library/Caches/com.tyrveil.lutra/ |
On Linux, when built from source: settings in ~/.config/com.tyrveil.lutra/, journal and tools in ~/.local/share/com.tyrveil.lutra/.
From a build before the installers. Earlier builds used the identifier dev.lutra.desktop. The first start of a new build copies settings.json, the recovery journal and the downloaded Phpactor from the old dev.lutra.desktop folders once and shows a notification; the old folders stay untouched and can be deleted afterwards. The web view's old folder (%LOCALAPPDATA%\dev.lutra.desktop\, ~/Library/WebKit/dev.lutra.desktop/) holds only caches: Lutra keeps nothing in the web view's storage, so nothing is lost there, and it can be deleted too.
An instance started with --control PORT or --data-dir DIR keeps its files in its own folder (see development.md).
Revision history
| Date | Change | Summary |
|---|---|---|
| 2026-10-31 | major | B1: initial version, NSIS setup and DMG, unsigned |
| 2026-10-31 | minor | B2: finish-page hang found and fixed, Open with for PHP files, version 0.1.0-alpha |
| 2026-11-01 | minor | C2: lutra CLI in both installers, optional per-user PATH entry on Windows, macOS link step, xtask bundle prints the version; the web view's folder holds no user state |