diff --git a/README.md b/README.md index e36bffc..d400363 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,31 @@ + +> [!NOTE] +> 本文档由 WeHub 基于上游 README 翻译整理,属于社区翻译,非官方中文文档。 +> [English](./README.en.md) · [原始项目](https://github.com/esengine/DeepSeek-Reasonix) · [上游 README](https://github.com/esengine/DeepSeek-Reasonix/blob/HEAD/README.md) +> 原作者、版权与许可证归属以原始项目及本仓库 LICENSE 文件为准。 +

Reasonix

- English + English  ·  - 简体中文 + 简体中文  ·  - Guide + 指南  ·  - Spec + 规格  ·  - Website + 官方网站  ·  Discord

> [!IMPORTANT] -> **Reasonix 1.0 is a ground-up rewrite in Go** — this branch (`main-v2`) is the new default and where development happens now. -> The earlier `0.x` TypeScript releases are **legacy**, living on the [`v1`](https://github.com/esengine/DeepSeek-Reasonix/tree/v1) branch (maintenance only). -> See the **[migration guide](./docs/MIGRATING.md)**. `npm i -g reasonix` stays the install command — `1.0.0`+ delivers the Go binary, `0.x` is the legacy TS build. +> **Reasonix 1.0 是用 Go 从零重写的版本** —— 本分支(`main-v2`)已是新的默认分支,后续开发都在这里。 +> 早期的 `0.x` TypeScript 版本转为 **legacy**,保留在 [`v1`](https://github.com/esengine/DeepSeek-Reasonix/tree/v1) 分支(仅维护)。 +> 详见**[迁移指南](./docs/MIGRATING.md)**。`npm i -g reasonix` 仍是安装命令——`1.0.0`+ 装的是 Go 二进制,`0.x` 是 legacy TS 版。

npm version @@ -35,68 +41,63 @@
-

A DeepSeek-native AI coding agent for your terminal.

-

A config- and plugin-driven harness — a single static Go binary, tuned around DeepSeek's prefix cache so token costs stay low across long sessions.

+

面向终端的 DeepSeek 原生 AI coding agent。

+

由配置与插件驱动的极薄 harness——单一静态 Go 二进制,围绕 DeepSeek 的前缀缓存调优,长会话也能把 token 成本压低。


> [!IMPORTANT] -> **Community · 加入社区** — bilingual Discord for setup help (`#help` / `#求助`), workflow showcases, and feature ideas. → **** +> **加入社区 · Community** — 双语 Discord,提供安装答疑(`#help` / `#求助`)、工作流展示与功能想法。→ **** -
+## 特性 -## Features +- **配置驱动**:provider、agent、启用的工具、插件全部在 `reasonix.toml` 中声明, + 内核无硬编码模型。 +- **多模型 · 可组合**:DeepSeek 作为预设内置;任何 OpenAI 兼容 + 端点都只是一条配置。可选让两个模型协同(执行器 + 规划器),各自独立、缓存稳定的 session。 +- **插件驱动**:外部工具以子进程形式运行,通过 stdio JSON-RPC 通信(MCP 兼容); + 内置工具在编译期自注册。 +- **缓存友好的上下文维护**:启动时注入稳定的环境摘要;旧工具输出会先 snip/prune, + 再进入摘要 compaction;内置工具 schema 合约有文档和回归测试保护。 +- **零摩擦分发**:`CGO_ENABLED=0` 单二进制;一条命令交叉编译到六个目标平台。 + 唯一依赖是一个 TOML 解析库。 -- **Config-driven.** Providers, the agent, enabled tools, and plugins are all - declared in `reasonix.toml`. No hardcoded models. -- **Multi-model & composable.** DeepSeek ships as a preset; any - OpenAI-compatible endpoint is a config entry, not new code. Optionally run - two models together (executor + planner) in separate, cache-stable sessions. -- **Plugin-driven.** External tools run as subprocesses over stdio JSON-RPC - (MCP-compatible). Built-in tools self-register at compile time. -- **Cache-aware context maintenance.** Startup injects a small stable environment - summary, stale tool output is snipped/pruned before summary compaction, and the - built-in tool schema contract is documented for regression review. -- **Zero-friction distribution.** `CGO_ENABLED=0` single binary; cross-compile - to six targets with one command. The only dependency is a TOML parser. - -## Install +## 安装 ```sh -npm i -g reasonix # any OS; pulls the prebuilt native binary +npm i -g reasonix # 任意系统;自动拉取对应平台的原生二进制 brew install esengine/reasonix/reasonix # macOS ``` -Prebuilt archives (`darwin|linux|windows × amd64|arm64`) and `SHA256SUMS` are on -every [GitHub release](https://github.com/esengine/DeepSeek-Reasonix/releases). +预编译归档(`darwin|linux|windows × amd64|arm64`)和 `SHA256SUMS` 见每个 +[GitHub release](https://github.com/esengine/DeepSeek-Reasonix/releases)。 -### Code signing +### 代码签名 -Windows builds are code-signed with a free certificate provided by the -[SignPath Foundation](https://signpath.org/), with signing through -[SignPath.io](https://signpath.io/). +Windows 构建使用 [SignPath 基金会](https://signpath.org/) 提供的免费代码签名证书, +通过 [SignPath.io](https://signpath.io/) 完成签名。 -### Build from source +### 从源码构建 ```sh make build # -> bin/reasonix(.exe) -make cross # -> dist/ (darwin|linux|windows × amd64|arm64) +make cross # -> dist/(darwin|linux|windows × amd64|arm64) ``` -## Quick start +## 快速开始 ```sh -reasonix setup # config wizard → ./reasonix.toml -export DEEPSEEK_API_KEY=sk-... # or let setup save it to Reasonix home .env -reasonix # then run /init to generate AGENTS.md (project memory) -reasonix run "implement the TODOs in main.go" -reasonix run --model deepseek-pro "add unit tests for this function" -echo "explain this code" | reasonix run +reasonix setup # 配置向导 → ./reasonix.toml +export DEEPSEEK_API_KEY=sk-... # 也可以让 setup 保存到 Reasonix 全局 .env +reasonix # 然后在会话里运行 /init 生成 AGENTS.md(项目记忆) +reasonix run "把 main.go 里的 TODO 实现掉" +reasonix run --model deepseek-pro "给这个函数补单元测试" +echo "解释这段代码" | reasonix run ``` -## Configuration +## 配置 -A minimal `reasonix.toml` — one provider and a default model — is enough to start: +一个最小的 `reasonix.toml`——一个 provider 加一个默认模型——就够跑起来: ```toml default_model = "deepseek-flash" @@ -109,45 +110,37 @@ model = "deepseek-v4-flash" api_key_env = "DEEPSEEK_API_KEY" ``` -Resolution order is **flag > `./reasonix.toml` > the user config file > -built-in defaults**; starting with **Reasonix v1.8.1**, the user file lives at -`~/.reasonix/config.toml` on macOS/Linux and -`%AppData%\reasonix\config.toml` on Windows. See -**[Configuration paths](./docs/CONFIG_PATHS.md)** for migration details and the -full `config.toml` / `.env` structure. Provider entries name secrets with -`api_key_env`; the secret values themselves live in Reasonix's global -`/.env`, shared by CLI and desktop. Project `.env` files are not -provider-key runtime fallbacks, but still feed workspace-scoped, non-provider -`${VAR}` expansion for MCP/plugin settings without importing Reasonix control -variables. Permissions, the sandbox, plugins (MCP), slash -commands, `@` references, and two-model setup are all in the -**[Guide](./docs/GUIDE.md)**. +优先级为 **flag > `./reasonix.toml` > 用户配置文件 > 内置默认值**;从 +**Reasonix v1.8.1** 开始,用户配置位于 macOS/Linux 的 `~/.reasonix/config.toml`, +Windows 为 `%AppData%\reasonix\config.toml`。迁移细节见 +**[配置路径](./docs/CONFIG_PATHS.zh-CN.md)**,其中也说明了全局 `config.toml` +和 `.env` 的完整结构。Provider 通过 `api_key_env` 命名密钥,真实密钥值保存在 +CLI 与桌面端共用的 Reasonix 全局 `/.env`;项目 `.env` 不再作为 +provider key 的运行时 fallback,但仍会作为当前 workspace 范围内的 MCP/plugin 非 provider `${VAR}` 展开来源,不导入 Reasonix 控制变量。权限、沙盒、插件(MCP)、 +斜杠命令、`@` 引用与双模型设置,全部在 **[指南](./docs/GUIDE.zh-CN.md)** 里。 -## Documentation +## 文档 -- **[Guide](./docs/GUIDE.md)** — configuration, permissions & sandbox, plugins - (MCP), slash commands, `@` references, two-model collaboration. -- **[Subagent profiles](./docs/SUBAGENT_PROFILES.md)** — create, share, preview, - run, edit, and safely delete isolated agent profiles from desktop or CLI. -- **[Capability diagnostics](./docs/CAPABILITY_DIAGNOSTICS.md)** — - `reasonix doctor capabilities`, desktop Settings → Diagnostics, and the - `/reasonix-guide` skill for skills/hooks/MCP/plugin troubleshooting. -- **[Bot guide](./docs/BOT_GUIDE.md)** — connect Feishu, Lark, and WeChat bots - from the desktop app, then use approvals, YOLO, and commands from IM. -- **[Spec](./docs/SPEC.md)** — engineering contract: architecture, registries, - data types, and roadmap. -- **[Task contracts & pause policy](./docs/TASK_CONTRACT.md)** — structure - complex requests with context, output boundaries, constraints, and when to ask. -- **[Tool contract](./docs/TOOL_CONTRACT.md)** — provider-visible built-in tool - names, read-only flags, and schema snapshot guard. -- **[Migrating from 0.x](./docs/MIGRATING.md)** — moving from the legacy - TypeScript releases to the 1.0 Go rewrite. -- **[Checkpoints & rewind](./docs/CHECKPOINTS.md)** — the snapshot-based edit - safety net (Esc-Esc / `/rewind`). +- **[指南](./docs/GUIDE.zh-CN.md)** —— 配置、权限与沙盒、插件(MCP)、斜杠命令、 + `@` 引用、双模型协同。 +- **[子智能体 Profile](./docs/SUBAGENT_PROFILES.zh-CN.md)** —— 在桌面端或 CLI + 创建、共享、预览、运行、编辑和安全删除隔离智能体 Profile。 +- **[能力诊断](./docs/CAPABILITY_DIAGNOSTICS.zh-CN.md)** —— + `reasonix doctor capabilities`、桌面端 **设置 → 诊断**,以及内置 Skill + `/reasonix-guide`,用于 skills / hooks / MCP / 插件排障。 +- **[机器人使用指南](./docs/BOT_GUIDE.zh-CN.md)** —— 桌面端连接飞书、Lark、微信 + Bot,以及 IM 里的审批、YOLO 和命令交互。 +- **[规格](./docs/SPEC.md)** —— 工程契约:架构、registry、数据类型与路线图。 +- **[任务合约与暂停策略](./docs/TASK_CONTRACT.zh-CN.md)** —— 用背景、输出边界、约束和暂停条件组织复杂请求。 +- **[工具合约](./docs/TOOL_CONTRACT.zh-CN.md)** —— provider 可见的内置工具名、 + read-only 标记和 schema 快照保护。 +- **[从 0.x 迁移](./docs/MIGRATING.md)** —— 从 legacy TypeScript 版本迁到 1.0 Go 重写版。 +- **[Checkpoints 与 rewind](./docs/CHECKPOINTS.md)** —— 基于快照的编辑安全网 + (Esc-Esc / `/rewind`)。
-## Star History +## Star 趋势 @@ -159,42 +152,41 @@ commands, `@` references, and two-model setup are all in the
-## Support +## 支持本项目 -If Reasonix has been useful and you'd like to say thanks, you can. It stays a coffee, not a contract — donations don't buy feature priority or change how issues get triaged. +如果 Reasonix 帮你省了时间或 token,欢迎请杯咖啡。捐助不会换来 feature 优先级,也不会影响 issue 的处理顺序——就是「谢谢」。 -- **International** — PayPal: [paypal.me/yuhuahui](https://paypal.me/yuhuahui) -- **国内** — 微信支付(扫码) +- **国内** — 微信支付(扫下方二维码) +- **海外** — PayPal: [paypal.me/yuhuahui](https://paypal.me/yuhuahui)

- WeChat Pay QR code + 微信支付收款码


-## Acknowledgments +## 致谢 -A small list of folks whose work has shaped Reasonix the most — the current top -20 contributors by commit count. The full contributor graph is on -[GitHub](https://github.com/esengine/DeepSeek-Reasonix/graphs/contributors?all=1). +下面这些朋友的工作塑造了 Reasonix 今天的样子 —— 当前按 commit 数统计的前 20 名贡献者。 +完整贡献者列表在 +[GitHub](https://github.com/esengine/DeepSeek-Reasonix/graphs/contributors?all=1)。 | Contributor | Contributor | Contributor | Contributor | | --- | --- | --- | --- | | [**SivanCola**](https://github.com/SivanCola) | [**esengine**](https://github.com/esengine) | [**ttmouse**](https://github.com/ttmouse) | [**lifu963**](https://github.com/lifu963) | -| **reasonix** (anonymous) | [**HUQIANTAO**](https://github.com/HUQIANTAO) | [**GTC2080**](https://github.com/GTC2080) | [**light-front-theory**](https://github.com/light-front-theory) | -| **merge-order-check** (anonymous) | [**Li-Charles-One**](https://github.com/Li-Charles-One) | [**eghrhegpe**](https://github.com/eghrhegpe) | **wufengfan** (anonymous) | +| **reasonix**(anonymous) | [**HUQIANTAO**](https://github.com/HUQIANTAO) | [**GTC2080**](https://github.com/GTC2080) | [**light-front-theory**](https://github.com/light-front-theory) | +| **merge-order-check**(anonymous) | [**Li-Charles-One**](https://github.com/Li-Charles-One) | [**eghrhegpe**](https://github.com/eghrhegpe) | **wufengfan**(anonymous) | | [**CVEngineer66**](https://github.com/CVEngineer66) | [**dependabot\[bot\]**](https://github.com/apps/dependabot) | [**lanshi17**](https://github.com/lanshi17) | [**SuMuxi66**](https://github.com/SuMuxi66) | | [**CnsMaple**](https://github.com/CnsMaple) | [**cyq1017**](https://github.com/cyq1017) | [**JesonChou**](https://github.com/JesonChou) | [**XTLine**](https://github.com/XTLine) | -Also a separate thank-you to [**Bernardxu123**](https://github.com/Bernardxu123) -for designing the project logo, and to -[AIGC Link](https://xhslink.com/m/80ngts127cA) for promoting the project on XiaoHongShu. +另外特别感谢 [**Bernardxu123**](https://github.com/Bernardxu123) 设计的项目 logo, +以及 [AIGC Link](https://xhslink.com/m/80ngts127cA) 在小红书上的推广。

- Contributors to esengine/DeepSeek-Reasonix + esengine/DeepSeek-Reasonix 贡献者

@@ -203,7 +195,7 @@ for designing the project logo, and to ---

- MIT — see LICENSE + MIT —— 见 LICENSE
- Built by the community at esengine/DeepSeek-Reasonix + esengine/DeepSeek-Reasonix 社区共建