EP

everyinc/proof-sdk

效率工作流

本页由 AI 翻译,技术细节请以原文为准。 查看原文

1123 stars 质量 65 趋势 31MIT

Proof SDK:开源协作编辑器、来源模型与代理 HTTP 桥

概览

Proof SDK 是开源编辑器、协作服务器、源头模型和代理 HTTP 桥,支持 Proof 中的协作文档。 如果你想要托管产品,可以使用Proof。Hosted Proof由Every.制作。 - 带来源追踪的协作标记下载编辑器 - 注释、建议和重写操作 - 实时协作服务器 - 用于状态、标记、编辑、存在和事件的代理HTTP桥 - 一个位于apps/proof-example下的小型示例应用 - packages/doc-core - packages/doc-editor - packages/doc-server - packages/doc-store-sqlite - packages/agent-bridge - apps/proof-example - server - src 默认设置是编辑器在 http://localhost:3000 服务,API 或服务器在 http://localhost:4000.

概述(AI 翻译)

Proof SDK 是开源编辑器、协作服务器、源头模型和代理 HTTP 桥,支持 Proof 中的协作文档。

如果你想要托管产品,可以使用Proof。Hosted Proof由Every.制作。

包含了什么

  • 带来源追踪的协作降价编辑器
  • 注释、建议和重写操作
  • 实时协作服务器
  • 代理HTTP桥,用于状态、标记、编辑、在席和事件
  • 一个位于[[T0]下的小型示例应用]

工作区布局

  • packages/doc-core
  • packages/doc-editor
  • packages/doc-server
  • packages/doc-store-sqlite
  • packages/agent-bridge
  • apps/proof-example
  • server
  • src

地方发展

要求:

  • Node.js 18+

安装依赖:

启动编辑器:

启动本地服务器:

默认设置是将编辑器服务于http://localhost:3000,API/服务器服务于http://localhost:4000。

核心路线

规范证明SDK路由:

  • POST /documents
  • GET /documents/:slug/state
  • GET /documents/:slug/snapshot
  • POST /documents/:slug/edit
  • POST /documents/:slug/edit/v2
  • POST /documents/:slug/ops
  • POST /documents/:slug/presence

本页由 AI 翻译,技术细节请以原文为准。

README

Proof SDK

Proof SDK is the open-source editor, collaboration server, provenance model, and agent HTTP bridge that power collaborative documents in Proof.

If you want the hosted product, use Proof. Hosted Proof is made by Every.

What Is Included

  • Collaborative markdown editor with provenance tracking
  • Comments, suggestions, and rewrite operations
  • Realtime collaboration server
  • Agent HTTP bridge for state, marks, edits, presence, and events
  • A small example app under apps/proof-example

Workspace Layout

  • packages/doc-core
  • packages/doc-editor
  • packages/doc-server
  • packages/doc-store-sqlite
  • packages/agent-bridge
  • apps/proof-example
  • server
  • src

Local Development

Requirements:

  • Node.js 18+

Install dependencies:

npm install

Start the editor:

npm run dev

Start the local server:

npm run serve

The default setup serves the editor on http://localhost:3000 and the API/server on http://localhost:4000.

Core Routes

Canonical Proof SDK routes:

  • POST /documents
  • GET /documents/:slug/state
  • GET /documents/:slug/snapshot
  • POST /documents/:slug/edit
  • POST /documents/:slug/edit/v2
  • POST /documents/:slug/ops
  • POST /documents/:slug/presence
  • GET /documents/:slug/events/pending
  • POST /documents/:slug/events/ack
  • GET /documents/:slug/bridge/state
  • GET /documents/:slug/bridge/marks
  • POST /documents/:slug/bridge/comments
  • POST /documents/:slug/bridge/suggestions
  • POST /documents/:slug/bridge/rewrite
  • POST /documents/:slug/bridge/presence

Compatibility aliases remain mounted for the hosted product, but the routes above are the public SDK surface.

Build

npm run build

The build outputs the web bundle to dist/ and writes dist/web-artifact-manifest.json.

Tests

npm test

Docs

  • AGENT_CONTRACT.md
  • docs/agent-docs.md
  • docs/proof.SKILL.md
  • docs/adr/2026-03-proof-sdk-public-core.md

License

  • Code: MIT in LICENSE
  • Trademark guidance: TRADEMARKS.md
在 GitHub 查看完整 README

推荐工具

换一个关键词,或者移除筛选条件。

安装

npx skillfish add everyinc/proof-sdk
新手?先看 mcpskill.org 教程 →