litruv e58b87ed3a
Tests / unit (pull_request) Successful in 17s
Tests / e2e (pull_request) Failing after 2m41s
Run the E2E job with host networking so the homeserver replies reach it. (#109)
The homeserver ruv.wtf (192.168.10.4) is a macvlan interface on the caddy-caddy-1 container on the runner host pizzabox. Replies to a bridge-networked job arrive on br-f192811a98b7 and DOCKER-ISOLATION-STAGE-2 drops them, so the login E2E times out. Host networking keeps request and reply on one path.
2026-11-03 12:16:17 +11:00
2026-02-21 17:50:50 +11:00
2023-02-24 17:30:37 +05:30

Paarrot

Paarrot is a Matrix client focusing primarily on simple, elegant and secure interface. The desktop app is built with Electron and based on Cinny.

Download

Installers for Windows and Linux can be downloaded from releases.

Operating System Download
Windows (x64) Get it on Windows
Linux (AppImage) Get it on Linux

Linux Installation

For the best AppImage experience, we recommend using AppImageLauncher which automatically integrates AppImages into your system.

Local development

To setup development locally run the following commands:

  • git clone --recursive http://synbox.ruv.wtf:8418/litruv/cinny-desktop.git
  • cd cinny-desktop/cinny
  • npm ci
  • cd ..
  • npm ci

To build the app locally, run:

  • npm run build

To start local dev server, run:

  • npm run dev

Testing

  • npm run test - unit and E2E
  • npm run test:unit - Vitest
  • npm run test:e2e - Playwright driving Electron

The E2E test drives the real Electron app against the vite dev server, so it needs the cinny dependencies installed and an X display. On a headless machine run it under xvfb: xvfb-run -a npm run test:e2e.

The E2E test logs in to a live homeserver over the network, so it needs network access and a working test account. It uses a dedicated account, never a personal one:

Variable Default
E2E_HOMESERVER ruv.wtf
E2E_USER giteaci
E2E_PASSWORD required, read from the environment, never committed

A failed E2E run attaches a screenshot and the main and renderer console logs to the report. CI uploads test-results/ and playwright-report/ as artifacts.

Plugin System

Paarrot includes a plugin system for extending and customising the app with JavaScript modules.

Installing Plugins

  1. Drop a plugin folder into your plugins directory:
    • Windows: %APPDATA%\paarrot\plugins\<plugin-name>\
    • Linux: ~/.config/Paarrot/plugins/<plugin-name>/ for the packaged app, ~/.config/paarrot/plugins/<plugin-name>/ when running from source
    • macOS: ~/Library/Application Support/Paarrot/plugins/<plugin-name>/
  2. Enable it in Settings → Plugins → Installed

What Plugins Can Do

  • Register custom slash commands
  • Intercept and modify messages
  • Inject buttons into 11 UI locations (nav lists, toolbars, headers, sidebar, menus)
  • Register custom themes
  • Hook into raw Matrix events
  • Run background tasks
  • Show system notifications

Plugin Locations (UI Buttons)

Plugins can inject buttons as nav list rows or icon buttons across the app:

Location Style Where
channel-list Nav row Space channel list
home-section Nav row Home panel, above room list
direct-messages Nav row DMs panel, below "Create Chat"
sidebar-actions Icon Left sidebar — above Explore and above Search
text-composer-toolbar Icon Message composer toolbar
composer-actions Icon Beside the + attach button
room-header Icon Room header bar
room-menu Icon Room ⋮ dropdown
message-actions Icon Message hover bar
user-menu Icon Right-click on user avatar
search-notification-section Icon Notifications page header

Documentation

S
Description
No description provided
Readme AGPL-3.0
35 MiB
2026-11-03 13:51:30 +11:00
Languages
JavaScript 90%
HTML 8.3%
Shell 1.6%