openclaw-sc 5.38.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.env.example +13 -0
- package/INSTALL.md +13 -0
- package/LICENSE +233 -0
- package/README.md +123 -0
- package/SECURITY.md +27 -0
- package/index.js +3479 -0
- package/lib/code-review-shared.js +164 -0
- package/lib/config.js +164 -0
- package/lib/constants.js +438 -0
- package/lib/decomposer.js +896 -0
- package/lib/dialog-recall.js +389 -0
- package/lib/env.js +59 -0
- package/lib/level-rules.js +72 -0
- package/lib/log-manager.js +258 -0
- package/lib/preemption.js +278 -0
- package/lib/priority-calc.js +134 -0
- package/lib/prompt-injection.js +748 -0
- package/lib/route-evidence.js +701 -0
- package/lib/shared-fs.js +244 -0
- package/lib/steward-rules.js +648 -0
- package/lib/task-center.js +602 -0
- package/lib/task-chain.js +713 -0
- package/lib/task-checker.js +317 -0
- package/lib/task-profiles.js +255 -0
- package/lib/tcell.js +411 -0
- package/lib/tool-auto-discover.js +522 -0
- package/lib/tool-enrich-subagent.js +375 -0
- package/lib/tool-handlers.js +178 -0
- package/lib/tool-selector.js +459 -0
- package/openclaw.plugin.json +55 -0
- package/package.json +63 -0
- package/security.js +141 -0
- package/tools/bridge.js +3288 -0
- package/tools/dashboard/tk-dashboard.py +262 -0
- package/tools/hippocampus-multi-search.js +1038 -0
- package/tools/hippocampus-sqlite.js +738 -0
- package/tools/hippocampus-store.js +262 -0
- package/tools/mcp-tools.config.json +653 -0
- package/tools/pipeline-engine.js +667 -0
- package/tools/sidecar/_check_tools.py +34 -0
- package/tools/sidecar/sidecar-server.cjs +1360 -0
- package/tools/sidecar/subagent-runner.cjs +1471 -0
- package/tools/system-tools.js +619 -0
- package/vector/README.md +100 -0
- package/vector/usearch-bridge.js +639 -0
- package/vector/usearch-http.js +74 -0
- package/vector/usearch-serve.js +156 -0
- package/workers/worker.js +1419 -0
package/.env.example
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# Optional provider keys. Leave blank in source control.
|
|
2
|
+
DEEPSEEK_API_KEY=
|
|
3
|
+
TAVILY_API_KEY=
|
|
4
|
+
OLLAMA_BASE_URL=http://127.0.0.1:11434
|
|
5
|
+
|
|
6
|
+
# Optional path to ripgrep. If empty, sc uses bundled rg when present or the
|
|
7
|
+
# system `rg` command from PATH.
|
|
8
|
+
SC_RG_PATH=
|
|
9
|
+
|
|
10
|
+
# Optional sidecar settings. Keep runtime state outside published packages.
|
|
11
|
+
SC_SIDECAR_PORT=18792
|
|
12
|
+
SC_INBOX_DELIVERY_MODE=notify-only
|
|
13
|
+
SC_INBOX_CHAT_INJECT=0
|
package/INSTALL.md
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# sc install notes
|
|
2
|
+
|
|
3
|
+
1. Install Node.js 22 or newer.
|
|
4
|
+
2. Run `npm install` and `npm run lint`.
|
|
5
|
+
3. Copy this directory to `%USERPROFILE%\.openclaw\workspace\plugins\sc`.
|
|
6
|
+
4. Enable the `sc` plugin in OpenClaw plugin configuration.
|
|
7
|
+
5. Keep real `.env`, logs, inbox events, task files, and local OpenClaw memory
|
|
8
|
+
outside the public repository.
|
|
9
|
+
|
|
10
|
+
Optional tools:
|
|
11
|
+
|
|
12
|
+
- Install ripgrep as `rg`, or set `SC_RG_PATH`.
|
|
13
|
+
- Set provider keys through environment variables only.
|
package/LICENSE
ADDED
|
@@ -0,0 +1,233 @@
|
|
|
1
|
+
# Business Source License 1.1
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Yupeng Zhou (周宇鹏)
|
|
4
|
+
|
|
5
|
+
This license is designed to protect the intellectual property of independent
|
|
6
|
+
creators while granting free use to individual users, students, researchers,
|
|
7
|
+
and small non-commercial operators.
|
|
8
|
+
|
|
9
|
+
──────────────────────────────────────────
|
|
10
|
+
|
|
11
|
+
## 1. Core Parameters
|
|
12
|
+
|
|
13
|
+
| | |
|
|
14
|
+
|---|---|
|
|
15
|
+
| Licensor | Yupeng Zhou |
|
|
16
|
+
| Software | Universal Brute Workpack — full-capability Agent MCP workpack |
|
|
17
|
+
| Change License | Apache License v2.0 |
|
|
18
|
+
| Change Date | 2030-06-29 |
|
|
19
|
+
|
|
20
|
+
On and after the Change Date, this software automatically converts to Apache
|
|
21
|
+
License v2.0. Prior to that date, the following terms are in full legal effect.
|
|
22
|
+
|
|
23
|
+
## 2. Grant — Free Use
|
|
24
|
+
|
|
25
|
+
The following uses are completely free, no authorization or payment required:
|
|
26
|
+
|
|
27
|
+
a) Individual developers for technical research, study, personal projects,
|
|
28
|
+
or personal Agent/MCP workflows on non-company devices;
|
|
29
|
+
|
|
30
|
+
b) Students and academic researchers for non-commercial experiments;
|
|
31
|
+
|
|
32
|
+
c) Individual operators with annual revenue under ¥1,000,000 RMB, for
|
|
33
|
+
internal non-sale tools that do not form a commercial product, commercial
|
|
34
|
+
service, SaaS, or paid automation offering.
|
|
35
|
+
|
|
36
|
+
Within the above scope, you may:
|
|
37
|
+
|
|
38
|
+
- Download and read source code;
|
|
39
|
+
- Run locally;
|
|
40
|
+
- Modify for personal or permitted internal use;
|
|
41
|
+
- Use in personal projects and non-commercial experiments.
|
|
42
|
+
|
|
43
|
+
## 3. Commercial Restrictions
|
|
44
|
+
|
|
45
|
+
Without written authorization from the Licensor, no person or entity may:
|
|
46
|
+
|
|
47
|
+
a) Use this software or derivatives in production, commercial products,
|
|
48
|
+
internal enterprise deployment, intranet deployment, commercial services,
|
|
49
|
+
paid consulting delivery, managed automation services, or Agent/MCP
|
|
50
|
+
tool platforms by any enterprise or organization with annual revenue
|
|
51
|
+
greater than or equal to ¥1,000,000 RMB;
|
|
52
|
+
|
|
53
|
+
b) Use this software or derivatives as a component of a product, service,
|
|
54
|
+
platform, plugin marketplace, AI agent system, automation workbench,
|
|
55
|
+
developer tool, SaaS, hosted MCP gateway, or internal corporate agent
|
|
56
|
+
infrastructure that is monetized directly or indirectly;
|
|
57
|
+
|
|
58
|
+
c) Replicate, port, or reconstruct functionally equivalent software in
|
|
59
|
+
any programming language based on understanding of this software's core
|
|
60
|
+
architecture and design, including but not limited to: full-capability
|
|
61
|
+
MCP tool orchestration, stdio/SSE dual transport workpack design,
|
|
62
|
+
profile-based tool exposure and denial, graceful degradation chains,
|
|
63
|
+
local file/search/code/command tool aggregation, memory recall fallback,
|
|
64
|
+
and Agent pipeline orchestration, and use it for commercial profit;
|
|
65
|
+
|
|
66
|
+
d) Package this software or derivatives as a commercial SaaS service,
|
|
67
|
+
hosted MCP service, enterprise internal service, OEM product, white-label
|
|
68
|
+
product, marketplace listing, or paid tool bundle without a commercial
|
|
69
|
+
license or revenue-sharing agreement with the Licensor;
|
|
70
|
+
|
|
71
|
+
e) Remove, obscure, or misrepresent this license, the Licensor, or the
|
|
72
|
+
Change Date in redistributed copies or derivative works.
|
|
73
|
+
|
|
74
|
+
## 4. Commercial Licensing
|
|
75
|
+
|
|
76
|
+
To use this software under the restricted scope above, contact the Licensor
|
|
77
|
+
for written commercial authorization.
|
|
78
|
+
|
|
79
|
+
Commercial license types include but are not limited to:
|
|
80
|
+
|
|
81
|
+
- Enterprise internal deployment license;
|
|
82
|
+
- OEM / white-label license;
|
|
83
|
+
- SaaS hosting license;
|
|
84
|
+
- Agent platform / MCP gateway integration license;
|
|
85
|
+
- Marketplace redistribution license;
|
|
86
|
+
- Revenue-sharing partnership model.
|
|
87
|
+
|
|
88
|
+
## 5. Enforcement
|
|
89
|
+
|
|
90
|
+
This agreement is a globally applicable commercial contract. Any person or
|
|
91
|
+
entity downloading, installing, copying, modifying, distributing, or using this
|
|
92
|
+
software is deemed to have read and agreed to all terms of this agreement,
|
|
93
|
+
regardless of location.
|
|
94
|
+
|
|
95
|
+
Jurisdiction:
|
|
96
|
+
|
|
97
|
+
a) Disputes within the PRC: governed by the laws of the People's Republic
|
|
98
|
+
of China and heard by the People's Court of the Licensor's domicile;
|
|
99
|
+
|
|
100
|
+
b) Disputes outside the PRC: governed by the UN CISG and international IP
|
|
101
|
+
conventions where applicable; parties agree to arbitration at HKIAC under
|
|
102
|
+
its rules, with Hong Kong as the seat of arbitration;
|
|
103
|
+
|
|
104
|
+
c) Regardless of jurisdiction, the Licensor may seek injunctive relief,
|
|
105
|
+
including interim and permanent injunctions, in courts where the
|
|
106
|
+
infringer's assets, users, infrastructure, or business are located.
|
|
107
|
+
|
|
108
|
+
Violations of Section 3 constitute breach of contract. The Licensor may:
|
|
109
|
+
|
|
110
|
+
a) Require the infringer to immediately cease use and destroy all copies;
|
|
111
|
+
b) Recover commercial profits obtained during the infringement as damages;
|
|
112
|
+
c) Seek statutory, contractual, and equitable remedies available under
|
|
113
|
+
applicable law;
|
|
114
|
+
d) File litigation or arbitration in a court/forum of competent jurisdiction.
|
|
115
|
+
|
|
116
|
+
## 6. Disclaimer
|
|
117
|
+
|
|
118
|
+
This software is provided "AS IS", without warranty of any kind, express or
|
|
119
|
+
implied, including but not limited to warranties of merchantability, fitness
|
|
120
|
+
for a particular purpose, non-infringement, security, availability, correctness,
|
|
121
|
+
or suitability for any production environment. In no event shall the Licensor
|
|
122
|
+
be liable for any damages arising from the use of this software.
|
|
123
|
+
|
|
124
|
+
---
|
|
125
|
+
|
|
126
|
+
# 商业源代码许可证 1.1 (中文版)
|
|
127
|
+
|
|
128
|
+
版权所有 (c) 2026 周宇鹏
|
|
129
|
+
|
|
130
|
+
本许可证旨在保护独立技术创新者的智力成果,同时为个人用户、学生、
|
|
131
|
+
研究者和小规模非商业使用者提供免费使用权利。
|
|
132
|
+
|
|
133
|
+
──────────────────────────────────────────
|
|
134
|
+
|
|
135
|
+
## 1. 核心参数
|
|
136
|
+
|
|
137
|
+
授权人 (Licensor): 周宇鹏
|
|
138
|
+
|
|
139
|
+
软件名称 (Software): Universal Brute Workpack — 全能力 Agent MCP 工作包
|
|
140
|
+
|
|
141
|
+
变更许可证 (Change License): Apache License v2.0
|
|
142
|
+
|
|
143
|
+
变更日期 (Change Date): 2030-06-29
|
|
144
|
+
|
|
145
|
+
自变更日期起,本软件将自动转为 Apache License v2.0。在此之前,
|
|
146
|
+
以下条款具备完全法律效力。
|
|
147
|
+
|
|
148
|
+
## 2. 免费使用范围
|
|
149
|
+
|
|
150
|
+
以下情况完全免费,无需授权,无需付费:
|
|
151
|
+
|
|
152
|
+
a) 个人开发者在非公司设备上用于技术研究、学习、个人项目或个人
|
|
153
|
+
Agent/MCP 工作流;
|
|
154
|
+
|
|
155
|
+
b) 学生及学术研究人员用于非商业目的的实验;
|
|
156
|
+
|
|
157
|
+
c) 年营业额低于 ¥100 万元人民币的个体经营者,用于自身非对外售卖
|
|
158
|
+
的内部工具,且不构成商业产品、商业服务、SaaS 或收费自动化服务。
|
|
159
|
+
|
|
160
|
+
在上述范围内,允许:
|
|
161
|
+
|
|
162
|
+
- 下载、阅读源码;
|
|
163
|
+
- 本地运行;
|
|
164
|
+
- 为个人或被允许的内部用途修改;
|
|
165
|
+
- 在个人项目和非商业实验中使用。
|
|
166
|
+
|
|
167
|
+
## 3. 商业限制
|
|
168
|
+
|
|
169
|
+
未经授权人书面授权,任何人或实体不得从事以下行为:
|
|
170
|
+
|
|
171
|
+
a) 任何年营业额大于或等于 ¥100 万元人民币的企业或组织,在生产环境、
|
|
172
|
+
商业产品、企业内部部署、内网部署、商业服务、付费咨询交付、托管
|
|
173
|
+
自动化服务或 Agent/MCP 工具平台中使用本软件或其衍生品;
|
|
174
|
+
|
|
175
|
+
b) 将本软件或其衍生品作为产品、服务、平台、插件市场、AI Agent 系统、
|
|
176
|
+
自动化工作台、开发者工具、SaaS、托管 MCP 网关或企业内部 Agent 基础
|
|
177
|
+
设施的组成部分,并直接或间接商业化;
|
|
178
|
+
|
|
179
|
+
c) 在理解本软件核心架构与设计思路后,采用任何编程语言进行功能等效
|
|
180
|
+
的复刻、移植或重构,并用于商业牟利。核心架构与设计思路包括但不
|
|
181
|
+
限于:全能力 MCP 工具编排、stdio/SSE 双 transport 工作包设计、
|
|
182
|
+
基于 profile 的工具暴露与 deny、渐进降级链路、本地文件/搜索/代码/
|
|
183
|
+
命令工具聚合、记忆召回 fallback、Agent pipeline 编排;
|
|
184
|
+
|
|
185
|
+
d) 未经商业授权或收入分成协议,将本软件或其衍生品打包为商业 SaaS、
|
|
186
|
+
托管 MCP 服务、企业内部服务、OEM 产品、白标产品、市场分发项或
|
|
187
|
+
收费工具包;
|
|
188
|
+
|
|
189
|
+
e) 在再分发副本或衍生作品中移除、遮蔽或错误表述本许可证、授权人或
|
|
190
|
+
变更日期。
|
|
191
|
+
|
|
192
|
+
## 4. 商业授权获取
|
|
193
|
+
|
|
194
|
+
如需在上述限制范围内使用本软件,请联系授权人获取书面商业授权。
|
|
195
|
+
|
|
196
|
+
商业授权类型包括但不限于:
|
|
197
|
+
|
|
198
|
+
- 企业内部部署授权;
|
|
199
|
+
- OEM / 白标授权;
|
|
200
|
+
- SaaS 托管授权;
|
|
201
|
+
- Agent 平台 / MCP 网关集成授权;
|
|
202
|
+
- 市场再分发授权;
|
|
203
|
+
- 收入分成合作模式。
|
|
204
|
+
|
|
205
|
+
## 5. 法律效力
|
|
206
|
+
|
|
207
|
+
本协议为全球适用的商业合同。任何个人或实体下载、安装、复制、修改、
|
|
208
|
+
分发或使用本软件,即视为已阅读并同意本协议全部条款,无论其所在地。
|
|
209
|
+
|
|
210
|
+
管辖权条款:
|
|
211
|
+
|
|
212
|
+
a) 中华人民共和国境内的争议,受中华人民共和国法律管辖,由授权人
|
|
213
|
+
所在地人民法院审理;
|
|
214
|
+
|
|
215
|
+
b) 中华人民共和国境外的争议,在适用范围内适用《联合国国际货物销售
|
|
216
|
+
合同公约》(CISG) 及国际知识产权相关公约,双方同意提交香港国际
|
|
217
|
+
仲裁中心 (HKIAC) 按其仲裁规则进行仲裁,仲裁地为香港;
|
|
218
|
+
|
|
219
|
+
c) 无论管辖地为何,授权人均有权在侵权方资产、用户、基础设施或营业地
|
|
220
|
+
的法院寻求禁令救济,包括临时禁令和永久禁令。
|
|
221
|
+
|
|
222
|
+
违反本协议第 3 条的行为构成违约。授权人有权:
|
|
223
|
+
|
|
224
|
+
a) 要求侵权方立即停止使用并销毁所有拷贝;
|
|
225
|
+
b) 追缴侵权期间的商业获利作为经济赔偿;
|
|
226
|
+
c) 寻求适用法律下的法定、合同及衡平救济;
|
|
227
|
+
d) 向有管辖权的法院或仲裁机构提起诉讼/仲裁。
|
|
228
|
+
|
|
229
|
+
## 6. 免责声明
|
|
230
|
+
|
|
231
|
+
本软件按"现状"提供,不附带任何明示或默示的担保,包括但不限于适销性、
|
|
232
|
+
特定用途适用性、不侵权、安全性、可用性、正确性或适合任何生产环境的
|
|
233
|
+
担保。在任何情况下,授权人均不对因使用本软件而产生的任何损害承担责任。
|
package/README.md
ADDED
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
# OpenClaw sc
|
|
2
|
+
|
|
3
|
+
sc is an OpenClaw plugin for local agent orchestration. It adds sub-agent task
|
|
4
|
+
dispatch, MCP-style tool routing, local worker jobs, memory search helpers, and
|
|
5
|
+
sidecar delivery plumbing for OpenClaw runtimes.
|
|
6
|
+
|
|
7
|
+
This repository is the public source package. It excludes private runtime
|
|
8
|
+
state, local logs, task inbox files, backups, service binaries, and credentials.
|
|
9
|
+
|
|
10
|
+
## What sc Provides
|
|
11
|
+
|
|
12
|
+
| Area | Capability |
|
|
13
|
+
| --- | --- |
|
|
14
|
+
| Sub-agent orchestration | Dispatches bounded sub-agent tasks and records completion artifacts. |
|
|
15
|
+
| MCP tool bridge | Exposes search, memory, file, code, worker, and pipeline tools through a bridge layer. |
|
|
16
|
+
| Local worker path | Runs deterministic local worker jobs without spending model tokens. |
|
|
17
|
+
| Memory helpers | Provides SQLite, FTS, and optional vector-search helper modules. |
|
|
18
|
+
| Sidecar integration | Receives sub-agent completion events through a sidecar server and inbox flow. |
|
|
19
|
+
| Safety controls | Includes prompt-injection checks, blocked-tool rules, and emergency stop boundaries. |
|
|
20
|
+
|
|
21
|
+
## Requirements
|
|
22
|
+
|
|
23
|
+
- OpenClaw with plugin support.
|
|
24
|
+
- Node.js 22 or newer.
|
|
25
|
+
- PowerShell on Windows for the documented install commands.
|
|
26
|
+
- Optional: `rg` / ripgrep installed on PATH, or set `SC_RG_PATH`.
|
|
27
|
+
- Optional: Tavily, DeepSeek, Ollama, or other provider keys depending on which
|
|
28
|
+
tools you enable.
|
|
29
|
+
|
|
30
|
+
The npm package does not include private runtime directories or Windows service
|
|
31
|
+
helpers. If your local deployment uses NSSM or bundled binaries, keep those in
|
|
32
|
+
your private runtime install, not in the public package.
|
|
33
|
+
|
|
34
|
+
## Install From Source
|
|
35
|
+
|
|
36
|
+
```powershell
|
|
37
|
+
git clone https://github.com/haoyun18881-beep/openclaw-sc.git
|
|
38
|
+
cd openclaw-sc
|
|
39
|
+
npm install
|
|
40
|
+
npm run lint
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
Copy the plugin into your OpenClaw plugin workspace:
|
|
44
|
+
|
|
45
|
+
```powershell
|
|
46
|
+
$target = "$env:USERPROFILE\.openclaw\workspace\plugins\sc"
|
|
47
|
+
New-Item -ItemType Directory -Force -Path $target | Out-Null
|
|
48
|
+
Copy-Item -Recurse -Force .\* $target
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
Then add or enable `sc` in your OpenClaw plugin configuration. The exact
|
|
52
|
+
OpenClaw config shape can vary by runtime version, but the plugin entry should
|
|
53
|
+
point at the copied `sc` directory and load `openclaw.plugin.json`.
|
|
54
|
+
|
|
55
|
+
## Runtime Configuration
|
|
56
|
+
|
|
57
|
+
Start from the empty example:
|
|
58
|
+
|
|
59
|
+
```powershell
|
|
60
|
+
Copy-Item .env.example .env
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
Keep real secrets out of git. Common settings:
|
|
64
|
+
|
|
65
|
+
| Variable | Purpose |
|
|
66
|
+
| --- | --- |
|
|
67
|
+
| `DEEPSEEK_API_KEY` | Optional model provider key used by configured tools. |
|
|
68
|
+
| `TAVILY_API_KEY` | Optional web-search key. |
|
|
69
|
+
| `OLLAMA_BASE_URL` | Optional local vision/model endpoint. |
|
|
70
|
+
| `SC_RG_PATH` | Optional explicit path to `rg`; otherwise sc tries bundled rg, then system `rg`. |
|
|
71
|
+
| `SC_SIDECAR_PORT` | Sidecar port when the sidecar server is used. |
|
|
72
|
+
| `SC_INBOX_DELIVERY_MODE` | Inbox completion delivery mode, for example `notify-only`. |
|
|
73
|
+
| `SC_INBOX_CHAT_INJECT` | Whether inbox completion messages are injected into chat. |
|
|
74
|
+
|
|
75
|
+
## Main Files
|
|
76
|
+
|
|
77
|
+
| Path | Purpose |
|
|
78
|
+
| --- | --- |
|
|
79
|
+
| `index.js` | OpenClaw plugin entry. |
|
|
80
|
+
| `openclaw.plugin.json` | Plugin metadata and tool contracts. |
|
|
81
|
+
| `lib/` | Core routing, task, memory, security, and orchestration modules. |
|
|
82
|
+
| `tools/bridge.js` | Tool bridge and MCP-style tool handlers. |
|
|
83
|
+
| `tools/sidecar/sidecar-server.cjs` | Sidecar server for completion delivery. |
|
|
84
|
+
| `tools/sidecar/subagent-runner.cjs` | Sub-agent runner process. |
|
|
85
|
+
| `workers/worker.js` | Local worker implementation. |
|
|
86
|
+
| `vector/` | Optional vector-search helper modules. |
|
|
87
|
+
|
|
88
|
+
## Validation
|
|
89
|
+
|
|
90
|
+
Run syntax checks:
|
|
91
|
+
|
|
92
|
+
```powershell
|
|
93
|
+
npm run lint
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
Preview the npm package contents:
|
|
97
|
+
|
|
98
|
+
```powershell
|
|
99
|
+
npm run pack:dry
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
The package preview should not include:
|
|
103
|
+
|
|
104
|
+
- `node_modules/`
|
|
105
|
+
- `logs/`
|
|
106
|
+
- `tools/sidecar/inbox/`
|
|
107
|
+
- `tools/sidecar/tasks/`
|
|
108
|
+
- `.env`
|
|
109
|
+
- private OpenClaw memory or session files
|
|
110
|
+
- `nssm.exe`
|
|
111
|
+
- backup files such as `*.bak`
|
|
112
|
+
|
|
113
|
+
## Security
|
|
114
|
+
|
|
115
|
+
sc can touch local files, memory records, tool outputs, and sub-agent task
|
|
116
|
+
artifacts. Review `SECURITY.md` before publishing forks or sharing task reports.
|
|
117
|
+
Never publish real `.env`, `openclaw.json`, logs, task-state JSON, inbox events,
|
|
118
|
+
credentials, cookies, tokens, private prompts, or full local paths from a
|
|
119
|
+
private deployment.
|
|
120
|
+
|
|
121
|
+
## License
|
|
122
|
+
|
|
123
|
+
Business Source License 1.1. See `LICENSE`.
|
package/SECURITY.md
ADDED
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# Security
|
|
2
|
+
|
|
3
|
+
sc is an OpenClaw plugin that can route local files, web search, memory lookup,
|
|
4
|
+
worker tasks, and sub-agent jobs. Treat prompts, task files, logs, memory
|
|
5
|
+
records, inbox events, screenshots, and API keys as sensitive.
|
|
6
|
+
|
|
7
|
+
## Do Not Commit
|
|
8
|
+
|
|
9
|
+
- `.env` or `.env.*`
|
|
10
|
+
- `openclaw.json` or private runtime configuration
|
|
11
|
+
- `logs/`, `tools/logs/`, `tools/sidecar/logs/`
|
|
12
|
+
- `tools/sidecar/inbox/` and `tools/sidecar/tasks/`
|
|
13
|
+
- `memory/`, `state/`, `backups/`, `runtime/`, `workspace/`
|
|
14
|
+
- request/response dumps, full task reports, private prompts, cookies, tokens,
|
|
15
|
+
API keys, Authorization headers, or private paths
|
|
16
|
+
|
|
17
|
+
## Runtime Boundaries
|
|
18
|
+
|
|
19
|
+
The public package excludes local runtime state and bundled service binaries.
|
|
20
|
+
Install external tools such as ripgrep through the operating system package
|
|
21
|
+
manager, or set `SC_RG_PATH` to a reviewed executable.
|
|
22
|
+
|
|
23
|
+
## Reporting Issues
|
|
24
|
+
|
|
25
|
+
Report only redacted reproduction details. Do not include real credentials,
|
|
26
|
+
private prompts, raw session logs, task-state JSON, inbox events, or full local
|
|
27
|
+
configuration files.
|