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.
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
Markdown
[](/listings/razorpay--slashdocs)HTML
<a href="/listings/razorpay--slashdocs"><img src="/api/listings/razorpay--slashdocs/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.
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.
- # slashdocs
- [](https://github.com/razorpay/slashdocs/actions/workflows/ci.yml)
- [](https://github.com/razorpay/slashdocs/releases/latest)
- [](https://hub.docker.com/r/razorpay/slashdocs)
- [](https://pkg.go.dev/github.com/razorpay/slashdocs)
- [](LICENSE)
- The collaborative workspace for agentic organizations.
- `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.
- Instead of pasting giant reports into chat, give the work a shared home where your team and its agents improve it together.
- ## What you can build with it
- - Agent-generated architecture reviews
- - Incident reports and postmortems
- - Product specs and launch plans
- - Data analysis reports
- - Design proposals with Mermaid/SVG diagrams
- - QA findings and browser-test reports
- - Internal dashboards captured as portable HTML
- ## Features
- - One self-contained HTML file per document
- - Browser review UI with sandboxed rendering
- - Comments on exact text or pinned to a spot in a chart or diagram, with replies, reactions, resolve/reopen, and unread marks
- - 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
- - 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
- - History of versions, with preview and restore. One sitting of typing is one version
- - Approvals: owners ask people or bots to approve, and a changed document asks them again
- - An inbox in the header for approval requests and threads that wait on you
- - `slashdocs docs wait`, which returns the review feedback to an agent when the reviewer stops writing
- - Search with `title:`, `from:`, `in:`, `label:` and date modifiers, folders with sharing, and labels
- - [Slack or Google Chat notifications, personal mute controls, and comment/heading links](docs/comment-notifications.md)
- - [Slack link previews](docs/comment-notifications.md#slack-link-previews) and a signed [webhook for approval events](docs/self-hosting.md#approval-events)
- - OpenID Connect for human users (Google, Okta, Entra ID, Keycloak, Dex, ...)
- - Native service accounts for headless/agent workflows
- - Remote MCP endpoint with browser OAuth—no local MCP process or CLI required
- - Go CLI with compact default output and JSON mode
- - Generated OpenAPI/Swagger docs
- - Self-hostable Go server with embedded React frontend
- - Dockerfile for container deployments
- ## Why one HTML file?
- 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.
- ```html
- <img src="data:image/png;base64,..." alt="embedded screenshot" />
- ```
- No separate image hosting is required for v1.
- ## Quickstart (docker compose)
- 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:
- ```bash
- 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:
- ```bash
- scripts/e2e.sh down
- ```
- If you started the normal quickstart project with `docker compose up`, stop that
- project with `docker compose down -v` instead.
- ## Install from source
- ```bash
- git clone https://github.com/razorpay/slashdocs.git
- cd slashdocs
- make build
- ```
- Binaries are written to:
- ```text
- bin/slashdocs-server
- bin/slashdocs
- ```
- ## Run with Docker
- Every tagged release publishes a multi-arch (amd64, arm64) image to Docker Hub
- at [`razorpay/slashdocs`](https://hub.docker.com/r/razorpay/slashdocs):
- ```bash
- docker pull razorpay/slashdocs:latest
- ```
- Copy [`.env.example`](.env.example) to `.env`, fill it in, and run. Pin an exact
- version (`razorpay/slashdocs:0.1.0`) or digest in production rather than `:latest`:
- ```bash
- docker run --rm -p 8080:8080 --env-file .env razorpay/slashdocs:latest
- ```
- Each [GitHub Release](https://github.com/razorpay/slashdocs/releases) also carries
- standalone CLI archives and the packaged Helm chart. See
- [docs/releasing.md](docs/releasing.md) for how releases are cut.
- 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).
- ## Connect an MCP client
- The application server exposes Streamable HTTP directly at:
- ```text
- https://your-slashdocs-host.example/mcp
- ```
- The same URL serves MCP revisions 2024-11-05 through 2026-07-28: clients on
- 2026-07-28 connect statelessly with `server/discover`, and older clients with
- the `initialize` handshake.
- Add that URL to a remote MCP client. Standards-based clients discover the
- server's OAuth metadata, open the normal slashdocs sign-in and consent flow, and
- receive a short-lived, audience-bound token using authorization code + PKCE.
- No slashdocs CLI or local MCP bridge is involved. Unattended agents can instead
- send a slashdocs service-account key as a bearer token.
- The MCP surface covers document, version, comment, sharing, approval, and
- folder workflows, plus management of existing service accounts. Creating service
- accounts or bearer keys is intentionally not exposed over MCP; mint those
- credentials in the web application or CLI. Client-local operations such as
- installing or updating the CLI, switching local contexts, or opening a browser
- are also not MCP tools.
- MCP mirrors the CLI's authoring conventions: `get_authoring_guidelines`
- serves the same sectioned guidelines as `slashdocs guidelines` (index first,
- then per-section detail). Default sharing of new documents is
- server-controlled: org deployments can set `SLASHDOCS_DEFAULT_DOC_PERMISSION`
- to `viewer`, `commenter`, or `editor` (default `private`), and both MCP and
- CLI creates report the applied `default_grant` so the share can be revoked.
- ## CLI quickstart
- ```bash
- slashdocs auth login localhost:8080
- slashdocs auth whoami
- slashdocs docs create report.html --title "Agent report"
- slashdocs docs list
- slashdocs docs pull doc_123 --out report.html
- slashdocs docs push doc_123 report.html --summary "Update findings"
- slashdocs docs edit doc_123 --old "TTL of 10 minutes" --new "TTL of 5 minutes"
- slashdocs docs comments list doc_123
- slashdocs docs comments create doc_123 --quote "important text" --body "Please clarify this."
- slashdocs docs comments create doc_123 --target chart --x 0.5 --y 0.2 --body "Label this axis."
- slashdocs docs comments resolve doc_123 cmt_123
- slashdocs docs wait doc_123
- ```
- Use `--json` for structured output:
- ```bash
- slashdocs --json docs list
- ```
- ## Development
- ```bash
- make build
- make swagger
- make test
- ```
- Useful targets:
- ```text
- make build build server and CLI
- make build-backend build API server
- make build-cli build CLI
- make build-frontend build embedded frontend assets
- make swagger regenerate OpenAPI docs
- make test run backend, CLI, and frontend tests
- make lint run Go, TypeScript, React, and formatting checks
- make e2e run the API and CLI compose smoke test
- make e2e-browser run the advisory Chromium browser suite
- ```
- Build the server through `make build-backend` rather than a bare `go build`.
- The target regenerates the iframe bridge and links its source fingerprint so
- startup can reject missing, stale, or corrupt embedded assets.
- ## Architecture
- 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.
- ```mermaid
- flowchart LR
- browser["Browser<br/>(React review UI)"]
- clients["slashdocs CLI / remote MCP agents"]
- subgraph server["slashdocs-server (single Go binary)"]
- api["REST API"]
- fe["Embedded frontend"]
- dl["Embedded CLI downloads<br/>+ install.sh"]
- render["Sandboxed document render"]
- end
- pg[("Postgres<br/>metadata, comments,<br/>grants, sessions, edit log")]
- s3[("S3-compatible blob store<br/>immutable HTML versions")]
- browser -- "app origin" --> api
- browser -- "app origin" --> fe
- browser -- "render origin" --> render
- clients -- "REST or /mcp" --> api
- clients -- "CLI install / update" --> dl
- api --> pg
- api --> s3
- render --> s3
- ```
- ## Project layout
- ```text
- api/ Go API server and embedded frontend assets
- cli/ Go CLI
- frontend/ React + Vite frontend
- docs/ Self-hosting, operator, and release docs
- ```
- ## API docs
- When the server is running:
- ```text
- /openapi.json
- /api-docs
- /commit.txt
- ```
- ## Security model
- 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.
- ## Telemetry
- 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.
- ## License
- MIT — see [LICENSE](LICENSE).
Ratings and comments
Sign in to rate this skill.
Sign inFree to use. If it’s helped, pass it on.