slashdocs
以下摘录自该仓库的 README(片段) · 在 GitHub 读完整 README →
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, and share them. Agents read the comments and publish the next version. Every version is kept.
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
- Anchored comments and resolve/reopen workflow
- Slack notifications, personal mute controls, and comment/heading links
- Immutable versions with optimistic concurrency
- 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.
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 (S3),
and a Dex identity provider — no cloud accounts or OAuth
setup needed:
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 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 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.
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:
If you started the normal quickstart project with docker compose up, stop that
project with docker compose down -v instead.
Install from source
Binaries are written to:
Run with Docker