快速开始

本页带你在本地构建 Tether、跑通测试、运行免密钥 Replay 交互,并启动文档站。

环境要求

  • .NET SDK 10+(仓库通过 global.json 固定 SDK 版本)
  • Node.js(仅在本地开发文档站时需要)

构建与测试

克隆仓库后,在根目录执行:

dotnet build Tether.slnx
dotnet test Tether.slnx

提交前检查

工程规范要求提交前 dotnet test 全绿;测试目录 tests/ 与 src/ 镜像对应。

第一次运行

CLI 入口支持无密钥的脚本化模型(ReplayLlm),不需要任何 API key 就能跑通一次完整交互:

dotnet run --project apps/Tether.Cli -- \
  --replies apps/Tether.Cli/replies/text.json \
  --send "Summarize this repository"
  • --replies 指向一份预录的模型回复;
  • --send 发送一条消息并把流式处理结果打到标准输出。

若需接入真实模型,请参考 配置模型与提供方;需要原生窗口与 Web UI 体验时,请参阅 桌面版。

本地开发文档站

文档站基于 Astro 构建,源码位于 site/,产物输出到 docs/(对应 GitHub Pages 根目录):

npm install
npm run docs:dev      # 本地开发预览
npm run docs:build    # 构建到 docs/
npm run docs:preview  # 预览构建产物

正文页面用 Markdown 撰写,在 frontmatter 里以 layout: ../layouts/BaseLayout.astro 套用文档布局;着陆页这类需要组件化的页面才用 .astro。

仓库结构

src/Cordis/     # 通用插件框架核心(与 agent 无关)
src/Cordis.*/   # Cordis 周边能力(Loader / Hmr / Scripting)
src/Tether.*/   # Tether 产品层能力包(Seam / Provider / Consumer)
apps/           # 进程宿主入口(Tether.Cli / Tether.Headless)
tests/          # 与 src 镜像的单元测试
site/           # 文档站源码
docs/           # GitHub Pages 构建产物

分层规则

src/Cordis/ 框架核心禁止引用任何 Tether.* 包;能力 seam 决定是否拆程序集——Service Definition 单独一个程序集(只有接口),Provider / Consumer 引用它。

下一步

在 GitHub 上编辑此页