Skip to content

README.md

Latest commit

 

History

History
129 lines (93 loc) · 6.33 KB

README.md

File metadata and controls

129 lines (93 loc) · 6.33 KB
Raw

Inspector Rust — Linux (Ubuntu)

Native Tauri 2 shell for Ubuntu and other Debian-based distros. Core logic lives in core/rust-lib; this directory is only the Linux bundle (config, icons, capabilities).

Quick start

From the repository root:

bash scripts/install-linux.sh   # apt deps + Node 20 + pnpm + Rust stable
source "$HOME/.cargo/env"       # if rustup was installed by the script
pnpm dev:linux                  # development (tray + Ctrl+Space popup)
pnpm build:linux                # release .deb + AppImage (AppImage may fail locally)
pnpm build:linux:deb            # .deb only — recommended on Ubuntu (exit 0)

Install artifacts:

  • Binary: target/release/inspector-rust
  • Bundle: target/release/bundle/deb/InspectorRust_<ver>_amd64.deb

Install (use the exact version, not a glob — old .deb files can linger in bundle/deb/):

sudo dpkg -i target/release/bundle/deb/InspectorRust_0.25.1_amd64.deb
killall inspector-rust 2>/dev/null; inspector-rust &

Build notes

Target Local Ubuntu CI
.deb pnpm build:linux:deb ✅
.AppImage Often fails with failed to run linuxdeploy unless libfuse2 is installed and FUSE works ✅ (CI installs libfuse2)

If pnpm build:linux exits 1 but you see Bundling InspectorRust_…_amd64.deb above the AppImage error, the .deb is still valid — install it, or use pnpm build:linux:deb next time.

AppImage troubleshooting: sudo apt install libfuse2, then rebuild. In Cursor’s integrated terminal, linuxdeploy sometimes fails for sandbox reasons; use a normal GNOME Terminal for AppImage builds.

What works on Linux

Feature Status
Clipboard history (Ctrl+Space) Yes
Snippets, notes, backup, calculator, colors Yes
AES-256 DB encryption + Secret Service keyring Yes (keyfile fallback)
Global shortcuts + system tray Yes (X11; Wayland may need compositor support)
Paste into focused app (Ctrl+V via enigo) Yes
ML background cutout (ONNX) Yes (offline)
Region screenshot (Ctrl+Shift+S) Yes with scrot (X11) or grim+slurp (Wayland)
Screen OCR (Ctrl+Shift+O) Requires tesseract + tesseract-ocr-eng (German optional: tesseract-ocr-deu)
In-app eyedropper Not yet (macOS/Windows only)
Text expander in-place (AX/UIA) Keystroke/clipboard fallback only

Data path: ~/.local/share/InspectorRust/history.db

System packages

Minimum (also used in CI):

sudo apt-get install -y \
  libwebkit2gtk-4.1-dev libayatana-appindicator3-dev librsvg2-dev patchelf \
  libxdo-dev libxcb-shape0-dev libxcb-xfixes0-dev build-essential pkg-config libssl-dev

Recommended for full feature set:

sudo apt-get install -y scrot tesseract-ocr tesseract-ocr-eng tesseract-ocr-deu
# Wayland only:
sudo apt-get install -y grim slurp

Desktop environment notes

  • X11: Global shortcuts and scrot -s region capture usually work out of the box.
  • Wayland (GNOME / Cinnamon): Tauri global shortcuts often do not fire (upstream issue). Inspector Rust registers system shortcuts automatically on first launch (via gsettings) — same keys as documented:
Action Shortcut What happens
Open popup Ctrl+Space inspector-rust --toggle-popup
OCR region Ctrl+Shift+O inspector-rust --ocr
Screenshot region Ctrl+Shift+S inspector-rust --screenshot
Pick color Ctrl+Shift+C inspector-rust --pick-color

Check under Settings → Keyboard → Custom Shortcuts (entries named “Inspector Rust — …”).

Automatic conflict handling (v2): On first start (and after profile upgrades) Inspector Rust:

  1. Scans existing custom shortcuts and GNOME Terminal copy/paste bindings via gsettings.
  2. Moves Terminal off Ctrl+Shift+C/V to Ctrl+C/V when that would clash with Inspector’s color/popup shortcuts.
  3. Picks the first free binding per action (defaults: Ctrl+Space for the popup, Ctrl+Shift+O/S/C for OCR/screenshot/colour; fallbacks e.g. Ctrl+Alt+… if occupied).

No manual ubuntu-terminal-copy-paste-ctrl-cv.sh required.

Settings UI: Open the app → Settings → Linux desktop shortcuts. The panel rescans conflicts, lists free presets per action, and supports record mode (press a combination, verify, then Save shortcuts). Auto-resolve all runs the same automatic install as first launch.

CLI / install script:

inspector-rust --setup-shortcuts   # force re-scan + install (after .deb upgrade)
bash scripts/install-linux.sh    # runs --setup-shortcuts when the binary is on PATH

  • X11: No extra setup — built-in global shortcuts usually work.

  • KDE Plasma: Not automated yet; bind shortcuts manually to the commands above.

  • Wayland region capture: Install grim and slurp (used when OCR/Screenshot runs from tray or CLI).

  • Clipboard on Wayland: If the log shows ext-data-control / wlr-data-control is missing, the app falls back to the X11 clipboard bridge. For full Wayland clipboard sync, use a compositor that supports those protocols, or run under an X11/XWayland session.

  • Autostart: Uses the Tauri autostart plugin (typically ~/.config/autostart/).

Troubleshooting

Problem Fix
webkit2gtk not found Run scripts/install-linux.sh or install libwebkit2gtk-4.1-dev
cargo / edition errors rustup default stable (need Rust ≥ 1.77)
Region capture fails Install scrot (X11) or grim+slurp (Wayland)
OCR shortcut errors sudo apt install tesseract-ocr tesseract-ocr-eng (optional German: tesseract-ocr-deu)
Ctrl+Space does nothing (Wayland) Restart app once (auto gsettings), or run bash scripts/install-desktop-shortcuts.sh after build
Conflict with copy/paste (Ctrl+Shift+C/V) Automatic on install/first start; or Settings → Linux desktop shortcuts → Auto-resolve all
Tray icon missing libayatana-appindicator3-dev + log out/in

Related docs