Skip to content
Back to search

salt.md

The open-source workspace for people and AI agents. Docs, databases and realtime collaboration with an MCP server in the same binary, so agents work in the same workspace on the same permissions. One Go binary, one SQLite file, self-hosted.

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/saltmd--salt-md/badge.svg)](/listings/saltmd--salt-md)

HTML

<a href="/listings/saltmd--salt-md"><img src="/api/listings/saltmd--salt-md/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.

These steps run a script from the network that findsafeskills does not scan.

curl -fsSL https://raw.githubusercontent.com/saltmd/salt.md/main/install.sh | sh

One command downloads the binary for your platform, installs it, starts it and prints the address to open. On a Linux server it sets itself up as a systemd service, and running it again upgrades it. No `curl` on the machine? `wget -qO- … | sh` does the same.

Or with Docker:

docker run -d -p 8420:8420 -v salt-data:/data ghcr.io/saltmd/salt.md:latest

There is nothing else to install: no database server, no cache, no object store. Reverse proxies, TLS and backups are in the [self-hosting guide](https://salt.md/wiki/self-hosting/).

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 · 177 lines · 1 finding marked

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

  1. <p align="center">
  2. <img src=".github/banner.png" alt="salt.md: One workspace. People and agents." width="100%">
  3. </p>
  4. <p align="center">
  5. Docs, databases and realtime editing for your team. The same workspace is open
  6. to Claude, ChatGPT and Cursor, on exactly the access you grant them.<br>
  7. One binary, on your own server.
  8. </p>
  9. <p align="center">
  10. <a href="https://salt.md"><b>Website</b></a> ·
  11. <a href="https://salt.md/demo/"><b>Live demo</b></a> ·
  12. <a href="https://salt.md/wiki/"><b>Documentation</b></a> ·
  13. <a href="#quickstart"><b>Quickstart</b></a>
  14. </p>
  15. <br>
  16. <p align="center">
  17. <img src=".github/hero.png" alt="A Tasks board in salt.md, cut in two: light mode on the left, dark mode on the right." width="100%">
  18. </p>
  19. ## Quickstart
  20. ```sh
  21. curl -fsSL https://raw.githubusercontent.com/saltmd/salt.md/main/install.sh | sh
    • Note: Pipes a downloaded script directly into a shell (curl | sh / wget | bash)
    • Line 27 on GitHub
  22. ```
  23. One command downloads the binary for your platform, installs it, starts it and
  24. prints the address to open. On a Linux server it sets itself up as a systemd
  25. service, and running it again upgrades it. No `curl` on the machine?
  26. `wget -qO- … | sh` does the same.
  27. Or with Docker:
  28. ```sh
  29. docker run -d -p 8420:8420 -v salt-data:/data ghcr.io/saltmd/salt.md:latest
  30. ```
  31. There is nothing else to install: no database server, no cache, no object
  32. store. Reverse proxies, TLS and backups are in the
  33. [self-hosting guide](https://salt.md/wiki/self-hosting/).
  34. ## People and agents in the same place
  35. An agent is asked to organise the launch notes. A page appears, a database is
  36. created, the rows fill in. A person opens the same board a second later and
  37. carries on. Same pages, same permissions, same history.
  38. Connect Claude, ChatGPT, Codex, Cursor, Gemini CLI or any other MCP client to
  39. `/mcp` and it works on the workspace you use:
  40. - **Pages**: create, edit, move, duplicate, trash and restore
  41. - **Databases**: create them, change the schema, add and query rows, set up views
  42. - **Search** with the same permission checks a person gets
  43. - **Bulk imports** from any JSON source, without the content passing through the agent
  44. - **Comments**, and an append-only note trail on every page
  45. - **Presence**: the page shows which agent is working on it, before you start typing
  46. **And a list it cannot touch.** No agent can create or delete accounts, issue
  47. tokens, take or restore a backup, change instance settings or decide who is in
  48. a workspace, and the server tells every agent that connects. A credential
  49. carries its person's access and never more, every workspace decides what agents
  50. may do there, and the activity log keeps their changes apart from yours.
  51. [MCP tools](https://salt.md/wiki/mcp-tools/) · [Agent access](https://salt.md/wiki/agent-access/) · [Permissions](https://salt.md/wiki/permissions/)
  52. ## A whole workspace
  53. <table>
  54. <tr>
  55. <td width="50%" valign="top">
  56. <picture>
  57. <source media="(prefers-color-scheme: dark)" srcset="wiki/img/workspace-overview-dark.png">
  58. <img src="wiki/img/workspace-overview.png" alt="A page in the block editor.">
  59. </picture>
  60. <p><b>Write.</b> A block editor with a slash menu, checklists, code,
  61. tables, callouts and diagrams. Page links, backlinks, covers and icons.</p>
  62. </td>
  63. <td width="50%" valign="top">
  64. <picture>
  65. <source media="(prefers-color-scheme: dark)" srcset="wiki/img/collection-table-dark.png">
  66. <img src="wiki/img/collection-table.png" alt="A collection as a table with typed columns.">
  67. </picture>
  68. <p><b>Organise.</b> Any page becomes a collection with typed properties:
  69. select, date, person, relation, rollup, formula and more.</p>
  70. </td>
  71. </tr>
  72. <tr>
  73. <td width="50%" valign="top">
  74. <picture>
  75. <source media="(prefers-color-scheme: dark)" srcset="wiki/img/collection-calendar-dark.png">
  76. <img src="wiki/img/collection-calendar.png" alt="The same collection as a month calendar.">
  77. </picture>
  78. <p><b>Plan.</b> Table, board, list, gallery, calendar, timeline or form,
  79. each with its own filters. Any date can be an iCal feed.</p>
  80. </td>
  81. <td width="50%" valign="top">
  82. <picture>
  83. <source media="(prefers-color-scheme: dark)" srcset="wiki/img/search-dark.png">
  84. <img src="wiki/img/search.png" alt="The search dialog with passage results.">
  85. </picture>
  86. <p><b>Find.</b> Full-text search over every page and the text inside
  87. uploaded PDFs, one shortcut away from anywhere.</p>
  88. </td>
  89. </tr>
  90. <tr>
  91. <td width="50%" valign="top">
  92. <picture>
  93. <source media="(prefers-color-scheme: dark)" srcset="wiki/img/comments-panel-dark.png">
  94. <img src="wiki/img/comments-panel.png" alt="A page with the comments panel open.">
  95. </picture>
  96. <p><b>Together.</b> Realtime editing with live cursors, comments, page
  97. history and an activity log.</p>
  98. </td>
  99. <td width="50%" valign="top">
  100. <picture>
  101. <source media="(prefers-color-scheme: dark)" srcset="wiki/img/graph-dark.png">
  102. <img src="wiki/img/graph.png" alt="The library showing pages as a graph of linked dots.">
  103. </picture>
  104. <p><b>Connect.</b> The library holds every page you can open, and the
  105. graph shows what links where.</p>
  106. </td>
  107. </tr>
  108. </table>
  109. Moving in? Markdown files, CSVs and a Notion export import from the same menu.
  110. ## Under the hood
  111. ```mermaid
  112. flowchart LR
  113. people(["People<br>browser · desktop · phone"]) --> salt
  114. agents(["Agents<br>Claude · ChatGPT · Cursor"]) -- MCP --> salt
  115. tools(["Your tools"]) -- "REST · webhooks · iCal" --> salt
  116. salt["salt.md<br>one Go binary"] --> data[("SQLite file<br>+ uploads")]
  117. ```
  118. One Go process, built with `CGO_ENABLED=0`: a static binary with a pure-Go
  119. SQLite driver and the frontend embedded. No PostgreSQL, no Redis, no object
  120. store, no separate collaboration server.
  121. - **Install**: one binary, `install.sh`, or the Docker image
  122. - **Data**: one SQLite file plus an uploads directory
  123. - **Update**: swap the binary or pull the image, restart
  124. - **Backup**: stop, copy two paths, start
  125. - **Platforms**: Linux and macOS on amd64 and arm64, Windows on amd64
  126. The [desktop app](https://salt.md/wiki/desktop-app/) for macOS and Linux is a
  127. window onto a server you run, not a second copy of the product.
  128. ## Documentation
  129. [salt.md/wiki](https://salt.md/wiki/) covers every screen, every property type,
  130. every tool an agent can call and every setting on the server. It is written next
  131. to this code and checked against it on every build: a tool name that no longer
  132. exists, an API path that is not a route or a screenshot whose screen has changed
  133. fails the build. Every page is also plain Markdown at the same address with
  134. `.md` on the end, indexed for agents at
  135. [/wiki/llms.txt](https://salt.md/wiki/llms.txt).
  136. ## Contributing
  137. Issues and pull requests are welcome. Pull requests need a signed [CLA](CLA.md);
  138. [CONTRIBUTING.md](CONTRIBUTING.md) says what that means and why it exists.
  139. Security reports go to **dev@salt.md**, not to a public issue: see
  140. [SECURITY.md](SECURITY.md).
  141. ## License
  142. [AGPL-3.0](LICENSE). Use it, run it at work, change it. If you offer it to
  143. others over a network, publish your changes.
  144. The components salt.md is built on, with their licences in full, are in
  145. [THIRD-PARTY-NOTICES.md](THIRD-PARTY-NOTICES.md). A running instance serves the
  146. same list at `/licenses`.

Ratings and comments

Sign in to rate this skill.

Sign in

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