Plugins tab, logo, license, release workflow

Author: PluginMike

.github/workflows/ci.yml

@@ -0,0 +1,29 @@
+name: CI
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+      - name: System libraries
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y libwebkit2gtk-4.1-dev build-essential libxdo-dev libssl-dev libayatana-appindicator3-dev librsvg2-dev poppler-utils
+      - uses: actions/setup-node@v4
+        with: { node-version: 20, cache: npm }
+      - uses: dtolnay/rust-toolchain@stable
+      - uses: Swatinem/rust-cache@v2
+        with: { workspaces: src-tauri }
+      - run: npm ci
+      - name: Type check
+        run: npx tsc --noEmit -p .
+      - name: Rust tests
+        run: cargo test --manifest-path src-tauri/Cargo.toml
+      - name: Plugin tests
+        run: |
+          python3 plugins/nextcloud/test_nextcloud.py
+          python3 plugins/bitwarden/test_bitwarden.py

.github/workflows/release.yml

@@ -0,0 +1,50 @@
+name: Release
+# Push a tag like v1.2.0 (matching the version in tauri.conf.json): builds the AppImage and .deb on Ubuntu 22.04
+# (so they run on older glibc too) and publishes a GitHub release whose notes list the commits since the last tag.
+on:
+  push:
+    tags: ["v*"]
+
+permissions:
+  contents: write
+
+jobs:
+  release:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+        with: { fetch-depth: 0 }
+      - name: System libraries
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y libwebkit2gtk-4.1-dev build-essential libxdo-dev libssl-dev libayatana-appindicator3-dev librsvg2-dev patchelf libfuse2 file
+      - uses: actions/setup-node@v4
+        with: { node-version: 20, cache: npm }
+      - uses: dtolnay/rust-toolchain@stable
+      - uses: Swatinem/rust-cache@v2
+        with: { workspaces: src-tauri }
+      - run: npm ci
+      - name: Build
+        run: npm run tauri build -- --bundles appimage,deb
+      - name: Bundle plugins
+        run: tar -czf whale-cabinet-plugins-${GITHUB_REF_NAME}.tar.gz --exclude=__pycache__ --exclude='test_*' plugins
+      - name: Changelog
+        run: |
+          prev=$(git describe --tags --abbrev=0 "${GITHUB_REF_NAME}^" 2>/dev/null || true)
+          {
+            echo "## What's new"
+            echo
+            git log --no-merges --pretty='- %s' ${prev:+$prev..}"$GITHUB_REF_NAME"
+            echo
+            echo "**Install:** download the AppImage (\`chmod +x\` and run it) or the .deb. From source: \`scripts/install.sh\`."
+            echo "Plugins: unpack \`whale-cabinet-plugins-*.tar.gz\` into \`~/.local/share/whale-cabinet/\`."
+            if [ -n "$prev" ]; then echo; echo "Full diff: https://github.com/${GITHUB_REPOSITORY}/compare/${prev}...${GITHUB_REF_NAME}"; fi
+          } > notes.md
+          cat notes.md
+      - uses: softprops/action-gh-release@v2
+        with:
+          body_path: notes.md
+          files: |
+            src-tauri/target/release/bundle/appimage/*.AppImage
+            src-tauri/target/release/bundle/deb/*.deb
+            whale-cabinet-plugins-*.tar.gz

.gitignore

@@ -2,3 +2,4 @@ node_modules/
 dist/
 src-tauri/target/
 src-tauri/gen/
+__pycache__/

LICENSE

@@ -1,12 +1,22 @@
-# Whale Cabinet
+<p align="center"><img src="docs/logo.png" width="128" alt="Whale Cabinet logo"></p>
 
-A native Linux file manager with a flat filing-cabinet look (Tauri 2: Rust backend + TypeScript/Vite frontend).
-Window class / Wayland app id: `whale-cabinet`.
+# Whale Cabinet
 
+A Linux file manager with a flat filing-cabinet look: folders are drawers you pull out, files are paper.
+Built with Tauri 2 (Rust + TypeScript), made for Wayland/Hyprland and DankMaterialShell, and a drop-in
+replacement for Dolphin (same places, tags and ratings). Window class / Wayland app id: `whale-cabinet`.
 
+**Highlights:** tabs and split view · fuzzy quick open (Ctrl+P) and zoxide jumps (Ctrl+J) · a command palette
+(Ctrl+Shift+P) · git badges and actions · network locations (SFTP, SMB, WebDAV, NFS) · a built-in viewer for
+pictures, PDFs, video, code and Markdown · tags, colours and ratings shared with Dolphin · duplicate finder and
+disk-usage map · encryption · administrator actions through polkit · live theming from DMS and Hyprland ·
+**plugins** (Nextcloud, Immich and Bitwarden included).
 
 ## Install
 
+Download the AppImage or the .deb from [Releases](https://github.com/PluginMike/whale-cabinet/releases)
+(plus the plugins archive, unpacked into `~/.local/share/whale-cabinet/`), or build it yourself:
+
 ```sh
 scripts/install.sh              # build + install to ~/.local/bin (Dolphin stays the default)
 scripts/install.sh --default    # …and take over from Dolphin: default for folders + "Show in folder" (D-Bus)
@@ -86,7 +96,7 @@ fish users with a user-local rustup: `fish_add_path ~/.cargo/bin`.
 ## Tests
 
 ```sh
-(cd src-tauri && cargo test)   # 68 Rust unit tests: file ops, tags/xattrs, theme parsing (dank-colors.css,
+(cd src-tauri && cargo test)   # 69 Rust unit tests: file ops, tags/xattrs, theme parsing (dank-colors.css,
                                # dms-colors.json, hyprctl JSON), .desktop/mimeapps/globs, thumbnails, xbel, search, pty,
                                # fuzzy ranking, git porcelain, recently-used.xbel, gio prompts, admin helper, duplicates, plugins…
 (cd src-tauri && cargo test real_system -- --ignored --nocapture)   # Open With / icons against this machine
@@ -166,6 +176,16 @@ file), asking for the password — or, for key-encrypted files, gpg's own pinent
 
 ### Plugins
 
+Settings → **Plugins** (also Tools → *Plugins…* in the sidebar) lists the installed plugins with their settings
+and instructions. Included:
+
+- [**Nextcloud**](plugins/nextcloud/README.md): sync-status badges from the desktop client, Share… / Copy Public
+  Link / Open in Browser
+- [**Immich**](plugins/immich/README.md): your photo library as folders, smart search, upload and delete
+- [**Bitwarden**](plugins/bitwarden/README.md): search your vault from the palette, copy passwords and TOTP codes
+
+#### Writing a plugin
+
 A plugin is a folder in `~/.local/share/whale-cabinet/plugins/<name>/` with a `plugin.json` and an executable in
 any language. Whale Cabinet starts it once (it runs as you, so the first time it asks whether to allow it; Settings
 → Plugins turns it off again) and keeps it running, talking JSON lines over stdin/stdout.
@@ -211,37 +231,6 @@ in any order (so a plugin can work on several at once). Unasked messages `{"even
 An entry is `{name, path, dir?, size?, mtime? (ms), score? (sort order, highest first), thumb? (true), count?
 (a folder's "12 photos"), where?, info?: [[label, value]…]}`; its `path` is a location of the plugin's scheme.
 
-#### Nextcloud (bundled)
-
-With the Nextcloud desktop client running, items in your synced folders (from `~/.config/Nextcloud/nextcloud.cfg`)
-get its sync state as a badge — **✓** synced (blue when shared), **↻** syncing, **!** a problem, **⊘** excluded —
-updated live as the client syncs (it's the client's local socket, the one Dolphin's overlays use).
-Right-click → Nextcloud: *Share…* (the client's share dialog), *Copy Public Link* (reuses the item's public link
-or creates one; needs an app password from Nextcloud → Settings → Security in Settings → Plugins, kept in your
-keyring), *Open in Browser* (the item in the web UI). Check: `python3 plugins/nextcloud/test_nextcloud.py`.
-
-#### Immich (bundled)
-
-Settings → Plugins → Immich: your server's URL and an API key (Immich → Account Settings → API Keys; the key goes
-to your keyring). The sidebar's Immich section opens **Timeline** (a folder per month), **Albums** and
-**Favorites** as thumbnail folders, with EXIF in the info panel and Quick Look (Space) on the preview image.
-Opening a photo downloads the original (kept in `~/.cache/whale-cabinet/plugins/immich/`) and opens it with your
-app; Ctrl+C, *Copy To…* and dragging out copy the originals. **Ctrl+F** in Immich (or "Immich: search…" in
-Ctrl+Shift+P) is smart search: type what's in the picture; Enter opens a result, Shift+Enter shows all of them.
-Paste or drop files onto an Immich location to upload them (into an album: added to it; into Favorites: marked),
-or right-click local photos → Immich → *Upload to Immich*; Del moves photos to Immich's trash (it asks first).
-Reading needs asset.read/view/download, album.read, timeline.read; changing needs asset.upload, albumAsset.create,
-asset.update and asset.delete.
-
-#### Bitwarden (bundled)
-
-Needs [rbw](https://github.com/doy/rbw) (`sudo pacman -S rbw`). Settings → Plugins → Bitwarden: your server (empty
-for bitwarden.com; a self-hosted Bitwarden or Vaultwarden URL otherwise) and email. Ctrl+Shift+P → *Bitwarden:
-search…*: type part of a name, username or folder; **Enter** copies the password, **Shift+Enter** the username,
-**Ctrl+Enter** the TOTP code. rbw's agent asks for your master password (pinentry) and keeps the vault unlocked
-for its `lock_timeout`; the plugin never sees it. Passwords and codes are copied marked sensitive and cleared
-after 30 s (unless you copied something else). Check: `python3 plugins/bitwarden/test_bitwarden.py`.
-
 ### Recent files
 
 Recent (sidebar) lists what you opened lately, grouped Today / Yesterday / This week / … with bigger rows and
@@ -444,3 +433,13 @@ windowrulev2 = opacity 0.95 0.9, class:^(whale-cabinet)$
 windowrulev2 = float, class:^(whale-cabinet-dialog)$
 windowrulev2 = center, class:^(whale-cabinet-dialog)$
 ```
+
+## Contributing
+
+Issues and pull requests are welcome. `cargo test` (in `src-tauri`) and `npx tsc --noEmit` should pass;
+`WC_SUITES=browse,ops,plugins scripts/smoke.sh` runs the app end to end. Releases are built by GitHub Actions
+when a `v*` tag is pushed.
+
+## License
+
+[GPL-3.0-or-later](LICENSE)

README.md

@@ -1,7 +1,7 @@
 {
   "name": "whale-cabinet",
   "private": true,
-  "version": "0.1.0",
+  "version": "1.0.0",
   "type": "module",
   "scripts": {
     "dev": "vite",
@@ -21,5 +21,6 @@
     "@tauri-apps/cli": "^2.12.0",
     "typescript": "^7.0.2",
     "vite": "^8.3.1"
-  }
+  },
+  "license": "GPL-3.0-or-later"
 }

assets/whale-cabinet.svg

@@ -0,0 +1,31 @@
+# Bitwarden
+
+Search your Bitwarden vault from the command palette and copy a password, username or TOTP code. Works with
+bitwarden.com and self-hosted servers (Bitwarden, Vaultwarden).
+
+## What it does
+
+Ctrl+Shift+P → *Bitwarden: search…*, then type part of an item's name, username or folder:
+
+- **Enter** copies the password
+- **Shift+Enter** copies the username
+- **Ctrl+Enter** copies the TOTP code
+
+Passwords and codes are copied marked as sensitive (so clipboard managers can skip them) and cleared after
+30 seconds, unless you've copied something else since.
+
+## Setup
+
+1. Install [rbw](https://github.com/doy/rbw), the unofficial Bitwarden CLI: `sudo pacman -S rbw` (Arch),
+   `cargo install rbw` elsewhere. It also needs `pinentry` and `wl-clipboard`.
+2. Settings → Plugins → Bitwarden: your server URL (leave empty for bitwarden.com) and email.
+3. Search. The first time, rbw asks you to log in; after that it asks for your master password when the vault
+   is locked.
+
+## Security
+
+The plugin never sees your master password: rbw's agent unlocks the vault through pinentry and keeps it
+unlocked for its `lock_timeout` (`rbw config set lock_timeout 3600`). Secrets go from rbw straight to the
+clipboard; search results only carry names, usernames and folders.
+
+Test: `python3 test_bitwarden.py`

docs/logo.png

@@ -0,0 +1,28 @@
+# Immich
+
+Your [Immich](https://immich.app) photos in the file manager: browse, search, download, upload and delete.
+
+## What it does
+
+- A sidebar section with **Timeline** (a folder per month), **Albums** and **Favorites**, shown as thumbnails,
+  with the photo's details (date, camera, exposure, place) in the info panel.
+- **Space** previews a photo; **Enter** opens the original (downloaded to `~/.cache/whale-cabinet/plugins/immich/`).
+- **Copy / Copy To… / drag out** copy the originals anywhere, or into other apps.
+- **Smart search**: Ctrl+F inside Immich (or Ctrl+Shift+P → *Immich: search…*). Describe what's in the picture;
+  Enter opens a result, Shift+Enter shows all of them.
+- **Upload**: paste (Ctrl+V) or drop files onto an Immich location or its sidebar entry, or right-click local
+  photos → Immich → *Upload to Immich*. Into an album adds them to it; into Favorites marks them.
+- **Delete**: Del moves photos to Immich's trash (after asking), so they can be restored there.
+- Right-click → *Open in Immich* opens the photo in the web app.
+
+## Setup
+
+1. In Immich: Account Settings → API Keys → *New API Key*. For browsing it needs `asset.read`, `asset.view`,
+   `asset.download`, `album.read` and `timeline.read`; for uploading and deleting also `asset.upload`,
+   `albumAsset.create`, `asset.update` and `asset.delete`.
+2. Settings → Plugins → Immich: your server URL (`https://photos.example.com`) and the API key (kept in your keyring).
+
+## Notes
+
+- Months are cut in UTC, so a photo taken just after midnight on the 1st can show up in the month before.
+- Uses only Python's standard library.