Skip to main content
Glama
ReasonContour

ReasonContour

by neo39351
README.md
<p align="center">
  <img src="app/ui/public/logo.svg" width="88" height="88" alt="ReasonContour logo" />
</p>
<h1 align="center">ReasonContour</h1>
<p align="center">
  <strong>简体中文</strong> · <a href="README.en.md">English</a>
</p>
<p align="center">
  <a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-66816b?style=flat-square" alt="MIT license" /></a>
  <a href="#快速开始"><img src="https://img.shields.io/badge/Node.js-%E2%89%A522.12-66816b?style=flat-square" alt="Node.js ≥22.12" /></a>
  <a href="docs/AI_USAGE.md"><img src="https://img.shields.io/badge/AI-MCP%20%2F%20CLI-b46a50?style=flat-square" alt="MCP / CLI" /></a>
</p>

**看清你和 AI 的讨论,是怎样一步步得出结论的。**

和 AI 的复杂讨论很容易跑偏:结论越积越多,早先的结论更新或被否,聊到第 30 轮时,已经没人记得当初为什么那样决定,甚至跑偏。ReasonContour 会把讨论变成一张随讨论更新的推理地图,让讨论主线时刻维持清晰,同时让每一次结论更新都能被方便地查看或审计。

![ReasonContour 实际浅色界面截图:自拟的团队知识库选型讨论,左侧为结论主图和当前前沿,右侧展开选中结论的完整推导。](docs/assets/reasoncontour-light.zh-CN.png)

<p align="center"><sub>实际界面截图 · 自拟示例:团队知识库选型</sub></p>

**主图只放结论:每个节点都是一次真正的收敛,读一遍就能看清整场讨论的骨架。**<br />
**副图保留推导:点开一条结论,就能看到它是怎么得出的,被否的选项和理由都在。**<br />
**前沿实时刷新:最后一个节点是正在讨论的问题,达成一致后定格成结论。**<br />
**对齐由你确认:只有你明确认同的内容才算定下,AI 不能擅自改写。**<br />
**自动与手动:AI 自动整理;你不认同时,可以用升、并、删、改四个操作调整,每一步都能撤销。**

## 快速开始

**Windows 安装版:**前往 [Releases](https://github.com/neo39351/ReasonContour/releases/latest) 下载 `windows-x64-setup.exe` 安装程序。无需安装 Node.js;系统缺少 WebView2 时,安装程序会联网自动补齐。

**从源码运行:**

需要 **Node.js 22.12 或更高版本**。

```sh
git clone https://github.com/neo39351/ReasonContour.git
cd ReasonContour
npm ci
npm run build
npm start
```

打开终端输出的本地地址,即可使用画布。Windows、macOS 和 Linux 均可通过本地浏览器运行。

## 接入你正在使用的 AI

在画布的 **AI** 菜单中复制连接说明或 MCP 配置,交给支持 MCP 的 AI 客户端或具备本地命令执行能力的编程助手。每段需要记录的讨论启动一个独立会话,之后 AI 就能随讨论维护主图与副图;不使用 MCP 时,也可通过 CLI 接入。

ReasonContour 本身不运行模型,也不会自动读取其他聊天。自动整理需要已连接的 AI 主动写入;只有你选择接入的讨论才会被记录。详见 [AI 接入指南](docs/AI_USAGE.md)。

## 在画布上操作

| 操作 | 使用方式 |
| --- | --- |
| 升 | 在副图节点菜单中,将一条推导升为主图结论 |
| 并 | 将主图节点拖到相邻节点,预览合并后松开保存 |
| 删 | 在节点菜单中删除,推导会保留并转接 |
| 改 | 双击标题直接编辑 |
| 撤销 / 重做 | `Ctrl+Z` / `Ctrl+Shift+Z` |

侧栏默认跟随当前前沿;选择其他结论即可固定查看它的推导、正文与历史。更多菜单中可切换中英文和浅色 / 深色 / 跟随系统,并导出 Markdown。

## 本地数据

讨论以明文文件保存在本机 `projects/` 目录。可通过环境变量 `REASONCONTOUR_DATA_DIR` 指定其他位置。没有内置账号、遥测或自动云备份;接入外部 AI 后,其数据处理遵循你选择的 AI 客户端和服务配置。

当前存储格式为 **v4**,旧格式不会自动迁移;请为旧数据保留备份或使用独立数据目录。

Windows 安装版默认将讨论保存在 `%LOCALAPPDATA%\ReasonContour\projects`,卸载会保留数据。源码版仍使用项目目录下的 `projects/`,两者不会自动互相导入。

## 构建 Windows 安装包

在 Windows x64 上运行:

```powershell
npm ci
npm run dist:win
```

输出为 `release/ReasonContour-0.5.2-windows-x64-setup.exe`,同时生成 `SHA256SUMS.txt`。构建会自动下载并验证 Node.js、WebView2 引导程序和 Inno Setup 编译器,首次构建需要联网。安装包内置运行时、应用和依赖许可,支持中英文安装、开始菜单快捷方式及卸载。

`npm run test:installer` 可在没有已安装 ReasonContour 的 Windows 用户环境中验证安装、启动、重新安装和卸载。推送与 `package.json` 版本一致的 `v*` 标签,会在 GitHub Actions 完成测试后自动发布 Release。详情见 [开发说明](docs/DEVELOPMENT.md)。

## 开发与贡献

```sh
npm test
npm run build
npx playwright install chromium
npm run test:browser
```

参阅 [贡献指南](CONTRIBUTING.md)、[开发说明](docs/DEVELOPMENT.md)、[架构](docs/ARCHITECTURE.md) 和 [推理图机制](docs/design/TREE_MECHANISM_SPEC.md)。可选的 Windows 桌面外壳从源码运行 `desktop/build.ps1` 构建,需要 .NET Framework 编译器、Node.js 与 WebView2 Runtime。

## 许可证

[MIT](LICENSE)。第三方依赖的许可说明见 [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md)。