diff --git a/README.md b/README.md index 6373460..81e6f9d 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,23 @@ Deterministic session evidence reports for [DeepSeek Harness](https://github.com **Reads the session log itself through `ctx.sessionQuery` — no recorder, no resident memory, no drift.** Sessions that existed before the plugin was installed export just as well as live ones. +## Quick Start + +**Requirements**: Node.js 20 or 22 · a DeepSeek Harness profile that mounts the `commands` and `sessionQuery` services (the shipped `web` / `agent` profiles qualify). + +```sh +dsh plugin --profile web add dsh-session-export +``` + +Then, inside any session: + +```text +/transcript # single-file HTML replay report of the current session +/stats # terminal stats card with cost estimate +``` + +Full details — GitHub install route, `cordis.patch.yml` snippet, configuration — in [Install](#install-out-of-tree-plugin) below. + ## Positioning `dsh-session-export` is a **session evidence layer**, not a memory optimizer. diff --git a/README.zh.md b/README.zh.md index 0479d08..2c02628 100644 --- a/README.zh.md +++ b/README.zh.md @@ -8,6 +8,23 @@ **通过 `ctx.sessionQuery` 直读会话日志本身——无旁路采集、无驻留内存、无数据漂移。** 装插件之前的历史会话照样能导。 +## 快速开始 + +**环境要求**:Node.js 20 或 22 · 挂载了 `commands` 与 `sessionQuery` 服务的 DeepSeek Harness profile(官方 `web` / `agent` profile 均满足)。 + +```sh +dsh plugin --profile web add dsh-session-export +``` + +装好后在任意会话里: + +```text +/transcript # 当前会话的单文件 HTML 复盘报告 +/stats # 终端统计卡片 + 成本估算 +``` + +完整细节(GitHub 安装方式、`cordis.patch.yml` 片段、配置项)见下文「安装」一节。 + ## 项目定位 `dsh-session-export` 是**会话证据层**,不是记忆优化器。