RedThread

README

# RedThread

[English](README.en.md) | [简体中文](README.zh-CN.md)

`RedThread` is a public, sanitized OpenClaw plugin package for structured task routing, reusable case/experience assets, and lower-context execution.

`RedThread（红绳）` 是一个公开、脱敏的 OpenClaw 插件包，用于结构化任务分拣、案例/经验复用，以及更低上下文成本的执行。

## What It Does | 它解决什么问题

- routes tasks before execution
- separates direct work, single-lane work, parallel work, and block-and-clarify
- supports writing reusable case / experience / maintenance assets
- reduces unnecessary context loading with scoped reads and candidate-first reuse
- keeps the public release separate from any personal runtime environment

- 在执行前先对任务做分拣
- 明确区分直做、单线、并行和阻断补齐
- 支持沉淀可复用的案例 / 经验 / 维护记录
- 用范围收缩和候选优先复用减少无关上下文
- 让公开发布版与任何个人现网环境彻底分离

## Quick Start | 快速开始

1. Read [README.en.md](README.en.md) or [README.zh-CN.md](README.zh-CN.md).
2. Pick your platform guide:
   [macOS](platforms/macos/INSTALL.md),
   [Windows](platforms/windows/INSTALL.md),
   [WSL2](platforms/wsl2/INSTALL.md).
3. Install the plugin from this repository or from a release ZIP.
4. Merge `examples/redthread.config.example.json` into the target `openclaw.json`.
5. Restart and verify:
   `openclaw gateway restart`
   `openclaw plugins list`
   `openclaw gateway health --json`

1. 阅读 [README.en.md](README.en.md) 或 [README.zh-CN.md](README.zh-CN.md)。
2. 选择你的平台说明：
   [macOS](platforms/macos/INSTALL.md)、
   [Windows](platforms/windows/INSTALL.md)、
   [WSL2](platforms/wsl2/INSTALL.md)。
3. 直接从本仓库或 release ZIP 安装插件。
4. 将 `examples/redthread.config.example.json` 合并进目标 `openclaw.json`。
5. 重启并验收：
   `openclaw gateway restart`
   `openclaw plugins list`
   `openclaw gateway health --json`

## Repository Layout | 仓库结构

- `index.js`, `openclaw.plugin.json`, `package.json`: canonical plugin source
- `skills/`: always-on RedThread skill
- `templates/`: reusable structured templates
- `examples/`: safe config example
- `prompts/`: one-shot install prompts for public package use
- `scripts/`: install helpers and release build script
- `platforms/`: package-specific README and install notes

- `index.js`、`openclaw.plugin.json`、`package.json`：插件正式源码
- `skills/`：红绳常驻技能
- `templates/`：结构化模板
- `examples/`：安全示例配置
- `prompts/`：公开包的一键安装提示词
- `scripts/`：安装 helper 与 release 构建脚本
- `platforms/`：平台包专用 README 和安装说明

## Public Boundary | 公开边界

This repository intentionally excludes:

- private runtime state
- personal paths
- private instance names
- runtime reports and logs
- machine-specific bootstrap scripts

本仓库刻意排除：

- 私有运行态
- 个人路径
- 私有实例名
- 运行报告与日志
- 机器专属 bootstrap 脚本

## Token Claim | Token 结论

RedThread is designed to reduce token cost, but this public repository does **not** claim that token savings have already been universally proven in production.

Current public claim:

> The token-saving structure is in place. The correct metric is `net_token_saving`, but long-term real-world validation is still required.

红绳的目标之一是降低 token 成本，但这个公开仓库**不**宣称“已经在所有真实场景中被完全证明稳定省 token”。

当前公开口径：

> 节省 token 的结构已经落地，正式指标是 `net_token_saving`，但长期真实场景验证仍然需要继续补证据。

## Release Build | Release 构建

Use:

```powershell
powershell -ExecutionPolicy Bypass -File .\scripts\build_release.ps1
```

to generate the three public ZIP packages under `dist/`.

使用：

```powershell
powershell -ExecutionPolicy Bypass -File .\scripts\build_release.ps1
```

即可在 `dist/` 下生成 3 个公开 ZIP 包。

## License | 许可证

This repository is released under the MIT License.

本仓库采用 MIT 许可证。