Install
Souspli runs on macOS, Windows and Linux.
Download
Installers are attached to each release at github.com/souspli/souspli/releases:
| Platform | File |
|---|---|
| macOS | Souspli-<version>-mac-<arch>.dmg |
| Windows | Souspli-<version>-win-x64.exe |
| Linux | Souspli-<version>-linux-<arch>.AppImage, or the .deb |
Or build it from source — it is three commands.
Installing
- macOS — open the
.dmgand drag Souspli to Applications. Builds are signed and notarized by Apple:arm64for Apple Silicon,x64for Intel. If you installed the Intel build on an Apple Silicon Mac, the next update moves you to the native one. - Windows — run the installer. It is signed, but SmartScreen may still warn while the certificate is new: More info → Run anyway.
- Linux —
chmod +x Souspli-*.AppImage, then run it; or install the.deb.
Updates
Souspli asks, on first launch, whether it may check GitHub for a new version once a day (what that reveals). If you say no, Help → Check for updates… still works. A found update is shown with its notes and is only downloaded, then installed on restart, when you say so.
The .deb package does not replace itself; Souspli tells you about the new version
and opens its release page. The AppImage, the macOS app and the Windows installer
update in place.
If you have more than one profile open, an update closes them all, because they all run the same app. The window you install from names the others first. Each one saves its work and quits properly, and all of them reopen in the new version. On Linux, the AppImage's file name changes to the new version, so update any shortcut or command that names the old file.
First run
Souspli shows a notice headed ⚠ Experimental alpha and asks you to acknowledge it. Read it; it is short and it is true:
- Your identity key is created on first launch and stored on your machine — protected by your operating system's keychain where one is available, and by a weaker software scheme where it is not. The badge in the top bar tells you which.
- Do not use this identity for anything valuable, and do not put anything in a letter that you could not bear to leak. A signed letter is public and permanent once shared.
Next comes the community forum: a page asking for a name, with what joining reveals written underneath. Join puts you in Coffee Talk, where you can post, comment and upvote straight away (forums); Not now closes it, and the Forum button in the top bar brings it back. Then the question about update checks.
Behind those, Souspli opens onto a welcome letter — a real one, bundled with the app and checked exactly like a letter from a stranger before it was shown. It is there so the first thing you see is what matters most: a letter below, and above it the header that tells you who signed it. It was signed by a key made for that one letter and then destroyed, so the address is a stranger's, and the header says so.
It is offered once. Delete it and it will not come back; a library that already holds something never receives it. With nothing open, the window says what Souspli is and offers the two ways in: Write a letter and Open a letter file….
Next: write your first letter, or open a .thing file somebody
sent you.
Where your data lives
| macOS | ~/Library/Application Support/Souspli |
| Windows | %APPDATA%\Souspli |
| Linux | ~/.config/Souspli |
That directory holds your encrypted identity file, the library index, the content-addressed blob store and the bundles you are able to re-serve. Deleting it deletes your identity. Back up your key first.
From a terminal
souspli --help lists what the command line does: print the version, print your
public keys (souspli identity), and run more than one identity on the same
machine with profiles — souspli --profile alice opens a separate Souspli with
its own identity and letters, in a window titled Souspli - alice, beside any
other. souspli profiles lists them; souspli profile delete alice deletes one
after asking you to type its name. Profiles live in a profiles folder inside the
directory above.
Where souspli is:
Linux, .deb |
souspli, on your PATH |
| Linux, AppImage | the AppImage itself: ./Souspli-*.AppImage --help |
| macOS | /Applications/Souspli.app/Contents/MacOS/Souspli |
| Windows | souspli.cmd in the install folder, %LOCALAPPDATA%\Programs\Souspli |
On Windows use souspli.cmd, not souspli.exe: the .exe is a windowed program and
cannot print to a console.