Skip to content
Back to search

synaplan-desktop

Synaplan Desktop — pair a computer with your Synaplan workspace and run Agent Skills locally (Windows, macOS, Linux)

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/metadist--synaplan-desktop/badge.svg)](/listings/metadist--synaplan-desktop)

HTML

<a href="/listings/metadist--synaplan-desktop"><img src="/api/listings/metadist--synaplan-desktop/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

On **Skills**, choose **From a folder**, **From a zip**, or **From a GitHub address**, review the file list, then confirm. Many community Agent Skills assume an unrestricted shell or network — Synaplan Desktop will refuse those. See [`docs/SKILLS.md`](docs/SKILLS.md).

| OS | Skills directory | | -- | ---------------- | | Windows | `%LOCALAPPDATA%\Synaplan\Desktop\skills\` | | macOS | `~/Library/Application Support/com.synaplan.desktop/skills/` | | Linux | `$XDG_DATA_HOME/synaplan-desktop/skills/` or `~/.local/share/synaplan-desktop/skills/` |

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 178 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

This file has changed since it was scanned, so this is not exactly the text that was scanned, and no line is marked. The findings are listed with the safety scan above.

  1. <div align="center">
  2. # Synaplan Desktop
  3. **Pair a computer with your Synaplan workspace and run Agent Skills locally.**
  4. [Synaplan](https://github.com/metadist/synaplan) &nbsp;·&nbsp; [Website](https://www.synaplan.com) &nbsp;·&nbsp; [Live app](https://web.synaplan.com) &nbsp;·&nbsp; [Docs](https://docs.synaplan.com/desktop) &nbsp;·&nbsp; [Discord](https://discord.com/invite/kQB3eDjWfF) &nbsp;·&nbsp; [Synamail](https://github.com/metadist/Synamail)
  5. [![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE)
  6. [![GitHub](https://img.shields.io/badge/GitHub-metadist%2Fsynaplan--desktop-181717?logo=github&logoColor=white)](https://github.com/metadist/synaplan-desktop)
  7. [![Docs](https://img.shields.io/badge/docs-docs.synaplan.com%2Fdesktop-6BA539)](https://docs.synaplan.com/desktop)
  8. <br />
  9. <img
  10. src="docs/screenshot.png"
  11. alt="Synaplan Desktop: a project home with chat, notes, files and the composer"
  12. width="920"
  13. />
  14. </div>
  15. ---
  16. A small native app for **Windows, macOS, and Linux**. It pairs with your
  17. [Synaplan](https://github.com/metadist/synaplan) workspace, chats through your
  18. existing account, and runs installed [Agent Skills](https://agentskills.io/specification)
  19. on this computer — under a folder allowlist, with no shell and no network.
  20. It uses **only your Synaplan account**. There is no second AI subscription and
  21. no vendor dashboard. The API key lives in the OS secret store (Windows Credential
  22. Manager, macOS Keychain, Linux Secret Service), never in a config file.
  23. > **Unsigned 1.0 preview.** Pair, chat, install or remove skills, check local
  24. > tools, and run web-queued jobs on a running (optionally autostarted) app.
  25. > **Build from source.** Signed public download comes after signing
  26. > (notarization is still deferred). Unsigned installers are for internal
  27. > testing only.
  28. ## What it is (and is not)
  29. **It is** a Tauri 2 + Vue 3 desktop client. It talks to Synaplan over the
  30. Anthropic-compatible Messages gateway (`/v1/messages`) and the desktop pairing
  31. API. Enabled skills run locally as `{program, args[]}` against allowlisted
  32. interpreters (Python, Node, LibreOffice). A message that names a file or the
  33. project folder can list, read and write files without a skill. Running a
  34. program still needs an enabled skill and your consent.
  35. **It is not** an Electron wrap of the Synaplan web app, and it never embeds
  36. `web.synaplan.com` in a WebView. It is not a general-purpose shell host: skills
  37. that need `bash`, `curl`, or the network are refused.
  38. ## Pair this computer
  39. 1. In Synaplan, open **Manage → Channels → Synaplan Desktop** and choose
  40. *Pair this computer* (the instance needs **Desktop access** on —
  41. `DESKTOP_AGENT.ENABLED`).
  42. 2. In the app, paste the **server address** from that dialog (for a local
  43. install that is the API, for example `http://localhost:8000`, not the web
  44. page port) and the short code.
  45. 3. The app stores a **scoped** key in the OS secret store. Disconnect the
  46. computer from the web UI at any time to revoke it.
  47. ## Docs
  48. | Topic | Link |
  49. | ----- | ---- |
  50. | Overview and pairing | [docs.synaplan.com/desktop](https://docs.synaplan.com/desktop) |
  51. | Skills | [docs.synaplan.com/desktop-skills](https://docs.synaplan.com/desktop-skills) |
  52. | Folders and the out-box | [docs.synaplan.com/desktop-folders](https://docs.synaplan.com/desktop-folders) |
  53. | Local tools (doctor) | [docs.synaplan.com/desktop-tools](https://docs.synaplan.com/desktop-tools) |
  54. | In-repo skills catalog | [`docs/SKILLS.md`](docs/SKILLS.md) |
  55. | Business use-case films | [`docs/demos/README.md`](docs/demos/README.md) |
  56. ## Bundled skills
  57. These ship with the app (`skills/bundled/`). Eleven need **Python 3** (standard
  58. library only). **pptx** needs `python-pptx` and stays blocked until that
  59. import works — the app never runs `pip`. See [`docs/BUNDLED_SKILLS.md`](docs/BUNDLED_SKILLS.md).
  60. | Skill | What it creates |
  61. | ----- | --------------- |
  62. | **csv-insights** | Markdown profile of a CSV (rows, fill rates, numeric and category summaries) |
  63. | **email-draft** | Unsent `.eml` draft for Outlook, Apple Mail, or Thunderbird |
  64. | **web-report** | Standalone HTML page from Markdown or plain text |
  65. | **slides** | Self-contained HTML presentation (arrow keys; no PowerPoint) |
  66. | **chart** | Bar or line chart from a CSV, as SVG inside a standalone HTML page |
  67. | **data-table** | Searchable, sortable HTML table from a CSV |
  68. | **calendar-event** | `.ics` invite for Outlook, Apple Calendar, or Google Calendar |
  69. | **vcard** | `.vcf` contact card for any address book |
  70. | **json-csv** | JSON array of objects ⇄ CSV |
  71. | **invoice** | Print-ready HTML invoice from a JSON spec |
  72. | **hello-files** | Tiny example that writes `hello.txt` into the out-box |
  73. | **pptx** | PowerPoint deck (blocked until `python-pptx` is installed) |
  74. ## Install extra skills
  75. On **Skills**, choose **From a folder**, **From a zip**, or **From a GitHub
  76. address**, review the file list, then confirm. Many community Agent Skills
  77. assume an unrestricted shell or network — Synaplan Desktop will refuse those.
  78. See [`docs/SKILLS.md`](docs/SKILLS.md).
  79. | OS | Skills directory |
  80. | -- | ---------------- |
  81. | Windows | `%LOCALAPPDATA%\Synaplan\Desktop\skills\` |
  82. | macOS | `~/Library/Application Support/com.synaplan.desktop/skills/` |
  83. | Linux | `$XDG_DATA_HOME/synaplan-desktop/skills/` or `~/.local/share/synaplan-desktop/skills/` |
  84. ## Developer quick start
  85. Prerequisites are installed by the setup script for your OS:
  86. ```bash
  87. # Linux
  88. bash scripts/setup-linux.sh
  89. # macOS
  90. bash scripts/setup-macos.sh
  91. # Windows (PowerShell)
  92. ./scripts/setup-windows.ps1
  93. ```
  94. Then run the app with the start script for your OS — it checks the toolchain
  95. (Node 22+, Rust, the platform libraries, `node_modules`) and names anything
  96. missing before it launches `npm run tauri dev`:
  97. ```bash
  98. ./start-linux.sh # Linux
  99. ./start-macos.command # macOS (also double-clickable in Finder)
  100. ./start-windows.ps1 # Windows (PowerShell)
  101. ```
  102. Add `--check` (Windows: `-Check`) to run only the checks. On headless Linux or
  103. WSL there is no system keyring; `./start-linux.sh --plaintext-key` opts into the
  104. dev-only key file (see `docs/DEVELOPMENT.md`). `npm run tauri dev` still works
  105. directly once everything is installed.
  106. ### Try it offline (no Synaplan server)
  107. ```bash
  108. npm run mock-server # starts http://localhost:8788
  109. npm run tauri dev # pair against http://localhost:8788 with any code
  110. ```
  111. The mock accepts pairing, lists a mock model, and streams a short chat reply.
  112. See [`docs/DEVELOPMENT.md`](docs/DEVELOPMENT.md) for the dev loop and
  113. [`docs/PLATFORMS.md`](docs/PLATFORMS.md) for per-OS build prerequisites.
  114. Run the full local gate (mirrors CI) before every commit:
  115. ```bash
  116. make ci-local
  117. ```
  118. ## Architecture
  119. - **`src/`** — Vue 3 + TypeScript UI. Talks to Rust only through
  120. `src/services/tauri.ts`.
  121. - **`src-tauri/synaplan-core/`** — platform-independent, unit-tested Rust core
  122. (paths, secret store, pairing, SSE parsing, config, frozen contract types).
  123. - **`src-tauri/synaplan-core/src/platform/`** — the only place OS differences
  124. live (`app_dirs`, `secret_store`).
  125. - **`src-tauri/src/`** — the thin Tauri shell (commands + events).
  126. - **`skills/bundled/`** — the twelve Agent Skills that ship with the app
  127. (eleven stdlib + a blocked-until-ready `pptx`).
  128. ## License
  129. Apache License 2.0 — see [`LICENSE`](LICENSE). Copyright 2026 metadist GmbH.
  130. ## Status
  131. Unsigned 1.0. Pairing, chat, skill install, doctor, tray, and the poll loop
  132. work. **Build from source** with the setup scripts above. Signed public
  133. installers are not published yet. On unsigned macOS, turning on “Start when I
  134. sign in” may show a Login Items warning — that is expected.

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.