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.
Badge for your README
Markdown
[](/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
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)
- <p align="center">
- <img src=".github/banner.png" alt="salt.md: One workspace. People and agents." width="100%">
- </p>
- <p align="center">
- Docs, databases and realtime editing for your team. The same workspace is open
- to Claude, ChatGPT and Cursor, on exactly the access you grant them.<br>
- One binary, on your own server.
- </p>
- <p align="center">
- <a href="https://salt.md"><b>Website</b></a> ·
- <a href="https://salt.md/demo/"><b>Live demo</b></a> ·
- <a href="https://salt.md/wiki/"><b>Documentation</b></a> ·
- <a href="#quickstart"><b>Quickstart</b></a>
- </p>
- <br>
- <p align="center">
- <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%">
- </p>
- ## Quickstart
- ```sh
- 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
- ```
- 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:
- ```sh
- 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/).
- ## People and agents in the same place
- An agent is asked to organise the launch notes. A page appears, a database is
- created, the rows fill in. A person opens the same board a second later and
- carries on. Same pages, same permissions, same history.
- Connect Claude, ChatGPT, Codex, Cursor, Gemini CLI or any other MCP client to
- `/mcp` and it works on the workspace you use:
- - **Pages**: create, edit, move, duplicate, trash and restore
- - **Databases**: create them, change the schema, add and query rows, set up views
- - **Search** with the same permission checks a person gets
- - **Bulk imports** from any JSON source, without the content passing through the agent
- - **Comments**, and an append-only note trail on every page
- - **Presence**: the page shows which agent is working on it, before you start typing
- **And a list it cannot touch.** No agent can create or delete accounts, issue
- tokens, take or restore a backup, change instance settings or decide who is in
- a workspace, and the server tells every agent that connects. A credential
- carries its person's access and never more, every workspace decides what agents
- may do there, and the activity log keeps their changes apart from yours.
- [MCP tools](https://salt.md/wiki/mcp-tools/) · [Agent access](https://salt.md/wiki/agent-access/) · [Permissions](https://salt.md/wiki/permissions/)
- ## A whole workspace
- <table>
- <tr>
- <td width="50%" valign="top">
- <picture>
- <source media="(prefers-color-scheme: dark)" srcset="wiki/img/workspace-overview-dark.png">
- <img src="wiki/img/workspace-overview.png" alt="A page in the block editor.">
- </picture>
- <p><b>Write.</b> A block editor with a slash menu, checklists, code,
- tables, callouts and diagrams. Page links, backlinks, covers and icons.</p>
- </td>
- <td width="50%" valign="top">
- <picture>
- <source media="(prefers-color-scheme: dark)" srcset="wiki/img/collection-table-dark.png">
- <img src="wiki/img/collection-table.png" alt="A collection as a table with typed columns.">
- </picture>
- <p><b>Organise.</b> Any page becomes a collection with typed properties:
- select, date, person, relation, rollup, formula and more.</p>
- </td>
- </tr>
- <tr>
- <td width="50%" valign="top">
- <picture>
- <source media="(prefers-color-scheme: dark)" srcset="wiki/img/collection-calendar-dark.png">
- <img src="wiki/img/collection-calendar.png" alt="The same collection as a month calendar.">
- </picture>
- <p><b>Plan.</b> Table, board, list, gallery, calendar, timeline or form,
- each with its own filters. Any date can be an iCal feed.</p>
- </td>
- <td width="50%" valign="top">
- <picture>
- <source media="(prefers-color-scheme: dark)" srcset="wiki/img/search-dark.png">
- <img src="wiki/img/search.png" alt="The search dialog with passage results.">
- </picture>
- <p><b>Find.</b> Full-text search over every page and the text inside
- uploaded PDFs, one shortcut away from anywhere.</p>
- </td>
- </tr>
- <tr>
- <td width="50%" valign="top">
- <picture>
- <source media="(prefers-color-scheme: dark)" srcset="wiki/img/comments-panel-dark.png">
- <img src="wiki/img/comments-panel.png" alt="A page with the comments panel open.">
- </picture>
- <p><b>Together.</b> Realtime editing with live cursors, comments, page
- history and an activity log.</p>
- </td>
- <td width="50%" valign="top">
- <picture>
- <source media="(prefers-color-scheme: dark)" srcset="wiki/img/graph-dark.png">
- <img src="wiki/img/graph.png" alt="The library showing pages as a graph of linked dots.">
- </picture>
- <p><b>Connect.</b> The library holds every page you can open, and the
- graph shows what links where.</p>
- </td>
- </tr>
- </table>
- Moving in? Markdown files, CSVs and a Notion export import from the same menu.
- ## Under the hood
- ```mermaid
- flowchart LR
- people(["People<br>browser · desktop · phone"]) --> salt
- agents(["Agents<br>Claude · ChatGPT · Cursor"]) -- MCP --> salt
- tools(["Your tools"]) -- "REST · webhooks · iCal" --> salt
- salt["salt.md<br>one Go binary"] --> data[("SQLite file<br>+ uploads")]
- ```
- One Go process, built with `CGO_ENABLED=0`: a static binary with a pure-Go
- SQLite driver and the frontend embedded. No PostgreSQL, no Redis, no object
- store, no separate collaboration server.
- - **Install**: one binary, `install.sh`, or the Docker image
- - **Data**: one SQLite file plus an uploads directory
- - **Update**: swap the binary or pull the image, restart
- - **Backup**: stop, copy two paths, start
- - **Platforms**: Linux and macOS on amd64 and arm64, Windows on amd64
- The [desktop app](https://salt.md/wiki/desktop-app/) for macOS and Linux is a
- window onto a server you run, not a second copy of the product.
- ## Documentation
- [salt.md/wiki](https://salt.md/wiki/) covers every screen, every property type,
- every tool an agent can call and every setting on the server. It is written next
- to this code and checked against it on every build: a tool name that no longer
- exists, an API path that is not a route or a screenshot whose screen has changed
- fails the build. Every page is also plain Markdown at the same address with
- `.md` on the end, indexed for agents at
- [/wiki/llms.txt](https://salt.md/wiki/llms.txt).
- ## Contributing
- Issues and pull requests are welcome. Pull requests need a signed [CLA](CLA.md);
- [CONTRIBUTING.md](CONTRIBUTING.md) says what that means and why it exists.
- Security reports go to **dev@salt.md**, not to a public issue: see
- [SECURITY.md](SECURITY.md).
- ## License
- [AGPL-3.0](LICENSE). Use it, run it at work, change it. If you offer it to
- others over a network, publish your changes.
- The components salt.md is built on, with their licences in full, are in
- [THIRD-PARTY-NOTICES.md](THIRD-PARTY-NOTICES.md). A running instance serves the
- same list at `/licenses`.
Ratings and comments
Sign in to rate this skill.
Sign inFree to use. If it’s helped, pass it on.