Skip to content
Back to search

slashdocs

Give your agents the power to publish reviewable HTML documents. Self-hosted server + CLI + remote MCP; agents push, humans review with comments and versions.

Safety scan

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

Checked today

Check it deeper on your machine

It has changed since its scan on 11 Nov 2026.

As a Claude Code plugin, install it and then ask Claude Code:

/plugin marketplace add keithmackay/mackayi/plugin install scanskillsafety@mackayiDo a deep scan of https://github.com/razorpay/slashdocs with scanskillsafety

Or from a terminal, clone it and run it:

git clone https://github.com/keithmackay/scanskillsafety-skill ~/.claude/skills/scanskillsafetynode ~/.claude/skills/scanskillsafety/cli.cjs --deep 'https://github.com/razorpay/slashdocs'

It checks the exact commit: every file, its packages against OSV (api.osv.dev), how it compares with this page's scan (findsafeskills.com receives the repository's address), and, if you agree, Claude reading every file with your own Claude subscription. It never runs the code.

Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/razorpay--slashdocs/badge.svg)](/listings/razorpay--slashdocs)

HTML

<a href="/listings/razorpay--slashdocs"><img src="/api/listings/razorpay--slashdocs/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.

The fastest way to try slashdocs is the bundled compose stack, which brings up the server with Postgres, [versitygw](https://github.com/versity/versitygw) (S3), and a [Dex](https://dexidp.io/) identity provider — no cloud accounts or OAuth setup needed:

git clone https://github.com/razorpay/slashdocs.git
cd slashdocs
docker compose up

This pulls the latest published image, so nothing is compiled on your machine. To run your local changes instead, use `docker compose up --build`. Building needs Docker with Compose v2 and the [Buildx](https://docs.docker.com/build/concepts/overview/#buildx) plugin, because the Dockerfile uses BuildKit features. Docker Desktop and Docker's official Engine packages include both. Distro packages may not: on Ubuntu or Debian, run `sudo apt install docker-buildx`. Check with `docker buildx version`.

Open <http://localhost:8080> and sign in as `admin@example.com` with password `password`.

Dex is the **development** login only. Real deployments configure Google or any other OIDC provider — see [Self-hosting](docs/self-hosting.md).

`make e2e` boots the same stack and runs the full non-interactive smoke test (login, documents, comments, sharing, folders, sandboxed rendering, SSE). `make e2e-browser` runs the advisory Chromium browser suite. It reuses a healthy slashdocs + Dex stack already listening on ports 8080 and 5556; otherwise it boots the isolated `slashdocs-e2e` compose project and leaves it running for inspection. Browser E2E is deliberately separate from `make ci`.

Tear down the isolated E2E project, including data volumes, with:

scripts/e2e.sh down

If you started the normal quickstart project with `docker compose up`, stop that project with `docker compose down -v` instead.

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 · 278 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. # slashdocs
  2. [![CI](https://github.com/razorpay/slashdocs/actions/workflows/ci.yml/badge.svg)](https://github.com/razorpay/slashdocs/actions/workflows/ci.yml)
  3. [![Release](https://img.shields.io/github/v/release/razorpay/slashdocs?sort=semver)](https://github.com/razorpay/slashdocs/releases/latest)
  4. [![Docker Pulls](https://img.shields.io/docker/pulls/razorpay/slashdocs)](https://hub.docker.com/r/razorpay/slashdocs)
  5. [![Go Reference](https://pkg.go.dev/badge/github.com/razorpay/slashdocs.svg)](https://pkg.go.dev/github.com/razorpay/slashdocs)
  6. [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
  7. The collaborative workspace for agentic organizations.
  8. `slashdocs` is where agents and people work on the same documents. Agents publish rich, self-contained HTML: reports, specs, dashboards, diagrams, and decision docs. People open them in the browser, comment on the exact words, fix the text in place together, approve them, and share them. Agents read the comments and publish the next version. Every version is kept in the history.
  9. Instead of pasting giant reports into chat, give the work a shared home where your team and its agents improve it together.
  10. ## What you can build with it
  11. - Agent-generated architecture reviews
  12. - Incident reports and postmortems
  13. - Product specs and launch plans
  14. - Data analysis reports
  15. - Design proposals with Mermaid/SVG diagrams
  16. - QA findings and browser-test reports
  17. - Internal dashboards captured as portable HTML
  18. ## Features
  19. - One self-contained HTML file per document
  20. - Browser review UI with sandboxed rendering
  21. - Comments on exact text or pinned to a spot in a chart or diagram, with replies, reactions, resolve/reopen, and unread marks
  22. - Live co-editing: editors change the document in place (words, paragraphs, lists, bold, italic and links), several at once, and readers see each change as it happens
  23. - Agent pushes merge with the text that people type; a push that changes the same text gets a conflict and leaves their text as it is
  24. - History of versions, with preview and restore. One sitting of typing is one version
  25. - Approvals: owners ask people or bots to approve, and a changed document asks them again
  26. - An inbox in the header for approval requests and threads that wait on you
  27. - `slashdocs docs wait`, which returns the review feedback to an agent when the reviewer stops writing
  28. - Search with `title:`, `from:`, `in:`, `label:` and date modifiers, folders with sharing, and labels
  29. - [Slack or Google Chat notifications, personal mute controls, and comment/heading links](docs/comment-notifications.md)
  30. - [Slack link previews](docs/comment-notifications.md#slack-link-previews) and a signed [webhook for approval events](docs/self-hosting.md#approval-events)
  31. - OpenID Connect for human users (Google, Okta, Entra ID, Keycloak, Dex, ...)
  32. - Native service accounts for headless/agent workflows
  33. - Remote MCP endpoint with browser OAuth—no local MCP process or CLI required
  34. - Go CLI with compact default output and JSON mode
  35. - Generated OpenAPI/Swagger docs
  36. - Self-hostable Go server with embedded React frontend
  37. - Dockerfile for container deployments
  38. ## Why one HTML file?
  39. A single HTML artifact is easy for agents to generate, easy to version, easy to archive, and easy to move through a CLI. Images can be embedded with base64 data URLs, and diagrams can be Mermaid, inline SVG, or rendered HTML/CSS.
  40. ```html
  41. <img src="data:image/png;base64,..." alt="embedded screenshot" />
  42. ```
  43. No separate image hosting is required for v1.
  44. ## Quickstart (docker compose)
  45. The fastest way to try slashdocs is the bundled compose stack, which brings up
  46. the server with Postgres, [versitygw](https://github.com/versity/versitygw) (S3),
  47. and a [Dex](https://dexidp.io/) identity provider — no cloud accounts or OAuth
  48. setup needed:
  49. ```bash
  50. git clone https://github.com/razorpay/slashdocs.git
  51. cd slashdocs
  52. docker compose up
  53. ```
  54. This pulls the latest published image, so nothing is compiled on your machine.
  55. To run your local changes instead, use `docker compose up --build`. Building
  56. needs Docker with Compose v2 and the
  57. [Buildx](https://docs.docker.com/build/concepts/overview/#buildx) plugin, because
  58. the Dockerfile uses BuildKit features. Docker Desktop and Docker's official
  59. Engine packages include both. Distro packages may not: on Ubuntu or Debian, run
  60. `sudo apt install docker-buildx`. Check with `docker buildx version`.
  61. Open <http://localhost:8080> and sign in as `admin@example.com` with password
  62. `password`.
  63. Dex is the **development** login only. Real deployments configure Google or
  64. any other OIDC provider — see [Self-hosting](docs/self-hosting.md).
  65. `make e2e` boots the same stack and runs the full non-interactive smoke test
  66. (login, documents, comments, sharing, folders, sandboxed rendering, SSE).
  67. `make e2e-browser` runs the advisory Chromium browser suite. It reuses a healthy
  68. slashdocs + Dex stack already listening on ports 8080 and 5556; otherwise it boots
  69. the isolated `slashdocs-e2e` compose project and leaves it running for inspection.
  70. Browser E2E is deliberately separate from `make ci`.
  71. Tear down the isolated E2E project, including data volumes, with:
  72. ```bash
  73. scripts/e2e.sh down
  74. ```
  75. If you started the normal quickstart project with `docker compose up`, stop that
  76. project with `docker compose down -v` instead.
  77. ## Install from source
  78. ```bash
  79. git clone https://github.com/razorpay/slashdocs.git
  80. cd slashdocs
  81. make build
  82. ```
  83. Binaries are written to:
  84. ```text
  85. bin/slashdocs-server
  86. bin/slashdocs
  87. ```
  88. ## Run with Docker
  89. Every tagged release publishes a multi-arch (amd64, arm64) image to Docker Hub
  90. at [`razorpay/slashdocs`](https://hub.docker.com/r/razorpay/slashdocs):
  91. ```bash
  92. docker pull razorpay/slashdocs:latest
  93. ```
  94. Copy [`.env.example`](.env.example) to `.env`, fill it in, and run. Pin an exact
  95. version (`razorpay/slashdocs:0.1.0`) or digest in production rather than `:latest`:
  96. ```bash
  97. docker run --rm -p 8080:8080 --env-file .env razorpay/slashdocs:latest
  98. ```
  99. Each [GitHub Release](https://github.com/razorpay/slashdocs/releases) also carries
  100. standalone CLI archives and the packaged Helm chart. See
  101. [docs/releasing.md](docs/releasing.md) for how releases are cut.
  102. See [Self-hosting](docs/self-hosting.md) for production setup and all environment variables. A Kubernetes Helm chart is available in [`charts/slashdocs`](charts/slashdocs).
  103. ## Connect an MCP client
  104. The application server exposes Streamable HTTP directly at:
  105. ```text
  106. https://your-slashdocs-host.example/mcp
  107. ```
  108. The same URL serves MCP revisions 2024-11-05 through 2026-07-28: clients on
  109. 2026-07-28 connect statelessly with `server/discover`, and older clients with
  110. the `initialize` handshake.
  111. Add that URL to a remote MCP client. Standards-based clients discover the
  112. server's OAuth metadata, open the normal slashdocs sign-in and consent flow, and
  113. receive a short-lived, audience-bound token using authorization code + PKCE.
  114. No slashdocs CLI or local MCP bridge is involved. Unattended agents can instead
  115. send a slashdocs service-account key as a bearer token.
  116. The MCP surface covers document, version, comment, sharing, approval, and
  117. folder workflows, plus management of existing service accounts. Creating service
  118. accounts or bearer keys is intentionally not exposed over MCP; mint those
  119. credentials in the web application or CLI. Client-local operations such as
  120. installing or updating the CLI, switching local contexts, or opening a browser
  121. are also not MCP tools.
  122. MCP mirrors the CLI's authoring conventions: `get_authoring_guidelines`
  123. serves the same sectioned guidelines as `slashdocs guidelines` (index first,
  124. then per-section detail). Default sharing of new documents is
  125. server-controlled: org deployments can set `SLASHDOCS_DEFAULT_DOC_PERMISSION`
  126. to `viewer`, `commenter`, or `editor` (default `private`), and both MCP and
  127. CLI creates report the applied `default_grant` so the share can be revoked.
  128. ## CLI quickstart
  129. ```bash
  130. slashdocs auth login localhost:8080
  131. slashdocs auth whoami
  132. slashdocs docs create report.html --title "Agent report"
  133. slashdocs docs list
  134. slashdocs docs pull doc_123 --out report.html
  135. slashdocs docs push doc_123 report.html --summary "Update findings"
  136. slashdocs docs edit doc_123 --old "TTL of 10 minutes" --new "TTL of 5 minutes"
  137. slashdocs docs comments list doc_123
  138. slashdocs docs comments create doc_123 --quote "important text" --body "Please clarify this."
  139. slashdocs docs comments create doc_123 --target chart --x 0.5 --y 0.2 --body "Label this axis."
  140. slashdocs docs comments resolve doc_123 cmt_123
  141. slashdocs docs wait doc_123
  142. ```
  143. Use `--json` for structured output:
  144. ```bash
  145. slashdocs --json docs list
  146. ```
  147. ## Development
  148. ```bash
  149. make build
  150. make swagger
  151. make test
  152. ```
  153. Useful targets:
  154. ```text
  155. make build build server and CLI
  156. make build-backend build API server
  157. make build-cli build CLI
  158. make build-frontend build embedded frontend assets
  159. make swagger regenerate OpenAPI docs
  160. make test run backend, CLI, and frontend tests
  161. make lint run Go, TypeScript, React, and formatting checks
  162. make e2e run the API and CLI compose smoke test
  163. make e2e-browser run the advisory Chromium browser suite
  164. ```
  165. Build the server through `make build-backend` rather than a bare `go build`.
  166. The target regenerates the iframe bridge and links its source fingerprint so
  167. startup can reject missing, stale, or corrupt embedded assets.
  168. ## Architecture
  169. Everything ships as one Go binary, `slashdocs-server`. It serves the REST API, the embedded React frontend, and the embedded per-platform CLI binaries (`/install.sh` and downloads). You bring Postgres and an S3-compatible bucket. The same binary answers on two hostnames: the app hostname for the authenticated UI and API, and a separate render hostname where document HTML is served inside a sandboxed frame — the browser's same-origin policy keeps untrusted documents away from your session.
  170. ```mermaid
  171. flowchart LR
  172. browser["Browser<br/>(React review UI)"]
  173. clients["slashdocs CLI / remote MCP agents"]
  174. subgraph server["slashdocs-server (single Go binary)"]
  175. api["REST API"]
  176. fe["Embedded frontend"]
  177. dl["Embedded CLI downloads<br/>+ install.sh"]
  178. render["Sandboxed document render"]
  179. end
  180. pg[("Postgres<br/>metadata, comments,<br/>grants, sessions, edit log")]
  181. s3[("S3-compatible blob store<br/>immutable HTML versions")]
  182. browser -- "app origin" --> api
  183. browser -- "app origin" --> fe
  184. browser -- "render origin" --> render
  185. clients -- "REST or /mcp" --> api
  186. clients -- "CLI install / update" --> dl
  187. api --> pg
  188. api --> s3
  189. render --> s3
  190. ```
  191. ## Project layout
  192. ```text
  193. api/ Go API server and embedded frontend assets
  194. cli/ Go CLI
  195. frontend/ React + Vite frontend
  196. docs/ Self-hosting, operator, and release docs
  197. ```
  198. ## API docs
  199. When the server is running:
  200. ```text
  201. /openapi.json
  202. /api-docs
  203. /commit.txt
  204. ```
  205. ## Security model
  206. Uploaded HTML should be treated as untrusted content. `slashdocs` renders documents in a sandboxed frame and requires app and render URLs on different hostnames. Scheme or port differences on the same hostname do not isolate cookies; the unsafe override is for local development only.
  207. ## Telemetry
  208. None. `slashdocs` collects no telemetry, analytics, or usage data, and phones home to no one. The only outbound calls the server makes are to your Postgres, your blob storage, your configured OpenID Connect provider during login, and the integrations that you turn on: Slack, Google Chat, GitHub, Google Groups, and the approval webhook.
  209. ## License
  210. MIT — see [LICENSE](LICENSE).

Ratings and comments

Sign in to rate this skill.

Sign in

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