scream-code 0.7.10 → 0.8.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/README.md CHANGED
@@ -1,52 +1,91 @@
1
- <img width="807" height="152" alt="image" src="https://github.com/user-attachments/assets/b589a9a5-ad1e-420a-aee0-f86c7ee06873" />
1
+ <p align="center">
2
+ <img width="128" height="128" alt="11" src="https://github.com/user-attachments/assets/26b707fa-1fd7-4dda-8484-e8c6b0bd7523" />
3
+ </p>
4
+
5
+ <p align="center">
6
+ <strong>Scream Code 属于你的本地 AI 智能助手</strong>
7
+ </p>
8
+
9
+ <p align="center">
10
+ <a href="https://www.npmjs.com/package/scream-code"><img src="https://img.shields.io/npm/v/scream-code?style=flat-square&logo=npm&logoColor=white" alt="npm version"></a>
11
+ <a href="https://www.npmjs.com/package/scream-code"><img src="https://img.shields.io/npm/dm/scream-code?style=flat-square&logo=npm&logoColor=white" alt="npm downloads"></a>
12
+ <a href="https://github.com/LIUTod/scream-code/blob/main/LICENSE"><img src="https://img.shields.io/github/license/LIUTod/scream-code?style=flat-square" alt="license"></a>
13
+ <a href="https://github.com/LIUTod/scream-code/stargazers"><img src="https://img.shields.io/github/stars/LIUTod/scream-code?style=flat-square&logo=github" alt="stars"></a>
14
+ <a href="https://github.com/LIUTod/scream-code/network/members"><img src="https://img.shields.io/github/forks/LIUTod/scream-code?style=flat-square&logo=github" alt="forks"></a>
15
+ <a href="https://github.com/LIUTod/scream-code/issues"><img src="https://img.shields.io/github/issues/LIUTod/scream-code?style=flat-square&logo=github" alt="issues"></a>
16
+ <a href="https://scream.chat"><img src="https://img.shields.io/badge/website-scream.chat-blue?style=flat-square" alt="website"></a>
17
+ <a href="https://nodejs.org"><img src="https://img.shields.io/badge/node-%3E%3D22.0.0-green?style=flat-square&logo=node.js&logoColor=white" alt="node version"></a>
18
+ <a href="https://github.com/LIUTod/scream-code"><img src="https://img.shields.io/badge/platform-macOS%20%7C%20Linux%20%7C%20Windows-lightgrey?style=flat-square" alt="platform"></a>
19
+ </p>
2
20
 
21
+ ---
3
22
 
4
- Scream Code 是一款省心的中文 AI Agent 助手。无需硬记代码,完全本地部署运行,无任何远程行为,高安全,用户直接用中/英文下达指令,vibe coding、写代码、查论文、改文件、清理电脑、查资料、制作研报、搜全网信息……你动嘴,它动手!
23
+ Scream Code 是一款省心的本地中文 AI Agent 助手。无需硬记代码,完全本地部署运行,无任何远程行为,高安全,用户直接用中/英文下达指令,vibe coding、写代码、查论文、改文件、清理电脑、查资料、制作研报、搜全网信息……你动嘴,它动手!
5
24
 
6
25
  ---
7
26
 
8
- ## 三分钟上手
27
+ ## ✨ 核心特性
28
+
29
+ <table>
30
+ <tr>
31
+ <td width="50%">
32
+ <h3>🎯 Goal loop 循环</h3>
33
+ <p>非无效loop,<strong>目标自主驱动</strong>,裁判Agent独立裁决目标达成。设定目标后自动多轮迭代执行,支持预算控制。拒绝浪费Token式无效Loop循环</p>
34
+ </td>
35
+ <td width="50%">
36
+ <h3>🐺 Wolfpack 群狼模式</h3>
37
+ <p><strong>无限制智能批量并发</strong>多Agent协同,并行处理大项目任务。内置coder/explore/plan/verify/reviewer/oracle/writer 等多种子 Agent,精准识别任务类型,item 数量无上限。</p>
38
+ </td>
39
+ </tr>
40
+ <tr>
41
+ <td width="50%">
42
+ <h3>🧠 永久记忆备忘录</h3>
43
+ <p><strong>痛点记忆结构化SQL提取</strong>,FTS5全文+Tag语义+向量三重检索不漂移。跨会话共享,越用越懂你。</p>
44
+ </td>
45
+ <td width="50%">
46
+ <h3>🛡️ 效率级轻量底层</h3>
47
+ <p><strong>企业级安全</strong>,本地部署,高度自由可拓展,系统级调用能力。完全本地运行,无任何远程行为。</p>
48
+ </td>
49
+ </tr>
50
+ <tr>
51
+ <td width="50%">
52
+ <h3>🔌 自定义拓展+多代理编排</h3>
53
+ <p><strong>MCP / Skill / 模型商</strong> /支持子Agent开启多代理编排可自定义模型。支持 DeepSeek、OpenAI、Anthropic 等。</p>
54
+ </td>
55
+ <td width="50%">
56
+ <h3>📱 多渠道互联</h3>
57
+ <p>通过 CC 打通<strong>微信、飞书、企微、钉钉</strong>等平台,远程调用不用慌。</p>
58
+ </td>
59
+ </tr>
60
+ </table>
9
61
 
10
- ### 第一步:安装
62
+ ---
11
63
 
12
- 前置条件:**Node.js >= 22.0.0** 和 **Git**。
64
+ ## 🚀 三分钟上手
13
65
 
14
- > **国内用户**:安装过程需从 GitHub 下载,建议科学上网,如遇网络错误请多尝试几次。
66
+ ### 第一步:安装
15
67
 
16
- **推荐:npm 安装(全平台通用)**
68
+ 前置条件:**Node.js >= 22** 建议同步安装 **Git**。
17
69
 
18
- ```bash
19
- npm install -g scream-code
20
- ```
21
- **一键安装(macOS / Linux)**
70
+ **推荐:npm 安装(全平台通用)更新安装都是这个指令**
22
71
 
23
72
  ```bash
24
- curl -fsSL https://raw.githubusercontent.com/LIUTod/scream-code/main/install.sh | bash
25
- ```
26
-
27
- **Windows — PowerShell:**
28
-
29
- ```powershell
30
- irm https://raw.githubusercontent.com/LIUTod/scream-code/main/install.ps1 | iex
73
+ npm install -g scream-code
31
74
  ```
32
75
 
33
76
  安装完成后,`scream` 命令自动加入 PATH。首次安装约需 2-5 分钟。
34
77
 
35
- **升级到新版本**
36
-
37
- ```bash
38
- cd ~/.scream-code && ./install.sh --upgrade
39
- ```
40
78
 
41
79
  ### 第二步:启动并配置 AI 服务
42
80
 
43
- 首次启动时,如果检测到没有配置模型,会自动进入交互式配置向导(`/config`)。按提示输入 API 地址、密钥、模型型号即可完成配置。
81
+ 首次启动时,如果检测到没有配置模型,会自动进入交互式配置向导(`/config`),可选择市面模型商一键配置
82
+ (`/config diy`) 支持自定义追加配置。按提示输入 API 地址、密钥、模型型号即可完成配置。
44
83
 
45
84
  **支持多个模型**(配置好后可用 `/model` 随时切换):
46
85
 
47
86
  > 支持自定义 API(DeepSeek、OpenAI、Anthropic、MiniMax、通义千问、硅基流动等(`/config diy`)需要输入隐藏指令)。
48
87
 
49
- 配置完成后,在交互模式下输入 `/model` 即可切换模型或删除模型,无需重启。`/config` 支持追加配置。
88
+ 配置完成后,在交互模式下输入 `/model` 即可切换模型或删除模型,无需重启(`/model diy`)可以单独设置子Agent模型配置。
50
89
 
51
90
  ### 审批面板
52
91
 
@@ -56,77 +95,94 @@ cd ~/.scream-code && ./install.sh --upgrade
56
95
 
57
96
  ---
58
97
 
59
- ## 核心功能
60
-
61
- - **对话式交互** —— 用自然语言描述需求,它自动写代码、改文件、跑命令
62
- - **安全第一** —— 修改文件前必须征得同意,`.env` 等敏感文件默认禁止操作
63
- - **权限引擎** —— 精细控制它能做什么(读取/写入/执行),防止误操作
64
- - **状态机机制** —— 防漂移,强化任务颗粒度,不出错,任务完成度高,降低 Token 消耗
65
- - **记忆备忘录** —— `/memory` 打开交互式记忆备忘录。定位为"任务经验记录":记录用户需求、执行方案、最终结果、踩坑记录、成功经验。三种提取触发:压缩时自动提取、退出会话时提取、心跳自动沉淀。跨会话共享,知识库tag分级、Agent自行查阅,支持手动注入到当前会话。
66
- - **dream** —— 输入`/dream` 定期整理重复和过时记录,注意,因记忆整理涉及删除,所以此功能在auto模式被设置为不可用,避免误删
67
- - **目标系统** —— `/goal` 开启自主目标循环,设定目标后自动多轮迭代执行。支持 WriteGoalNote 工具,模型自主管理工作笔记(记录验证过的事实、踩过的坑、关键决策),笔记在每轮续跑时自动注入,跨轮不丢失,压缩不丢失。支持预算控制(轮次/Token/时间)
68
- - **会话恢复** —— 随时中断,随时继续,对话历史自动保存,可通过 `/sessions` 浏览和恢复历史会话
69
- - **多模式** —— 交互模式、静默模式、计划模式、后台任务模式,可选
70
- - **MCP 扩展** —— 连接外部工具(数据库、浏览器、API 等)
71
- - **多 Agent 并行模式** —— 复杂任务自动拆解为多个子 Agent 同时执行,内置 coder/explore/plan/verify/writer 五类子 Agent。支持多角度分析、对抗验证等并行编排模式。
72
- - **技能中心** —— 内置多款技能可下载,用户也可以自行安装skill技能
73
- - **MCP** —— 内置浏览器自动化MCP和电脑桌面自动化MCP(目前仅支持mac),另外可自行添加或下载使用自定MCP
74
- - **wolfpack** —— 群狼模式,适合多文件多任务同时处理 拥有自动审批权限,建议执行审阅任务和协同工作时提前打开
98
+ ## 📖 核心功能
99
+
100
+ | 功能 | 说明 |
101
+ |------|------|
102
+ | 💬 **对话式交互** | 用自然语言描述需求,它自动写代码、改文件、跑命令 |
103
+ | 🔒 **安全第一** | 修改文件前必须征得同意,`.env` 等敏感文件默认禁止操作 |
104
+ | 🛡️ **权限引擎** | 精细控制它能做什么(读取/写入/执行),防止误操作 |
105
+ | ⚙️ **状态机机制** | 防漂移,强化任务颗粒度,不出错,任务完成度高,降低 Token 消耗 |
106
+ | 🧠 **记忆备忘录** | `/memory` 打开交互式记忆备忘录,跨会话共享,知识库tag分级 |
107
+ | 💤 **dream 整理** | `/dream` 定期整理重复和过时记录(auto模式下不可用,避免误删) |
108
+ | 🎯 **目标系统** | `/goal` 开启自主目标循环,支持预算控制(轮次/Token/时间) |
109
+ | 💾 **会话恢复** | 随时中断,随时继续,对话历史自动保存 |
110
+ | 🔄 **多模式** | 交互模式、静默模式、计划模式、后台任务模式 |
111
+ | 🔌 **MCP 扩展** | 连接外部工具(数据库、浏览器、API 等) |
112
+ | 🤖 **多 Agent 并行** | 复杂任务自动拆解为多个子 Agent 同时执行 |
113
+ | 🎨 **技能中心** | 内置多款技能可下载,用户也可以自行安装 skill 技能 |
114
+ | 🐺 **wolfpack** | 群狼模式,适合多文件多任务同时处理,拥有自动审批权限,子 Agent 并发无上限 |
75
115
 
76
116
  ---
77
117
 
78
- ## cc-connect 通过聊天远程控制screamcode
118
+ ## 📱 cc-connect 通过聊天远程控制
79
119
 
80
- - 支持微信、飞书、slack、钉钉、QQ、Telegram等,你可以在安装scream-code后一键安装cc-connect来控制你的screamcode
120
+ 支持微信、飞书、Slack、钉钉、QQ、Telegram 等,你可以在安装 scream-code 后一键安装 cc-connect 来控制你的 screamcode
81
121
 
82
- ###第一步:一键安装指令安装
122
+ ### 第一步:一键安装
83
123
 
124
+ ```bash
125
+ npm install -g cc-connect
84
126
  ```
85
- # npm install -g cc-connect
86
- ```
87
- ###第二步:打开screamcode,输入/cc-connect 按照提示选择你要接入的平台(配置完毕后不要再次配置,否则会覆盖原有配置)
88
127
 
89
- ###第三步:按照步骤完成配置与链接后,输入命令启动后台守护进程(关闭screamcode也可在后台聊天)
128
+ ### 第二步:配置平台
129
+
130
+ 打开 screamcode,输入 `/cc-connect` 按照提示选择你要接入的平台。
90
131
 
91
- **提示:关于会话系统
132
+ > ⚠️ **注意**:配置完毕后不要再次配置,否则会覆盖原有配置。
92
133
 
93
- - *远程聊天会话默认走cc标识注入会话管理系统,可通过斜杠命令进入进行管理和删除,也可以直接在电脑端直接继承会话继续让screamcode完成工作
134
+ ### 第三步:启动守护进程
94
135
 
95
- **提示:远程聊天快捷指令(已默认支持,飞书、微信等通道文件图片发送)
136
+ 按照步骤完成配置与链接后,输入命令启动后台守护进程(关闭 screamcode 也可在后台聊天)。
137
+
138
+ **远程聊天快捷指令:**
139
+
140
+ | 指令 | 说明 |
141
+ |------|------|
142
+ | `/new` | 创建新会话 |
143
+ | `/bind setup` | 开启文件传送功能,支持 PDF、图片等 |
144
+ | `/mode` | 查看可用模式 |
145
+ | `/mode yolo` | 自动批准所有工具 |
146
+ | `/mode default` | 每次工具调用前询问 |
96
147
 
97
- - /new 创建新会话
98
- - /bind setup 开启文件传送功能,支持PDF、图片等
99
- - /mode 查看可用模式
100
- - /mode yolo 自动批准所有工具
101
- - /mode default 每次工具调用前询问
102
148
  ---
103
149
 
104
- ## 项目灵感与感谢支持
150
+ ## 💡 项目灵感与感谢支持
105
151
 
106
152
  Scream 是我基于自身使用习惯与对 Agent 系统的理解,从零重构的一套工具型 Agent 框架。最早用 Rust 写,架构膨胀得厉害,最后成屎山了。经历了教训之后,彻底转向 TypeScript,也顺便做了大量减法。
153
+
107
154
  重构之后,我把精力集中在三件事上:并行调度和状态机 + 记忆系统的收敛设计 + 最大化释放模型本身的能力上。整体逻辑借鉴了 Agent harness 的思路,同时也参考了不少优秀开源项目的设计取舍与实现细节。现在的 Scream 不再追求功能堆叠,而是一个能稳定、高效执行意图的轻量化 Agent 底座。
108
155
 
109
156
  这个项目完全免费,开放使用,也欢迎反馈,并给出建议和改进。会持续根据实际使用场景继续打磨。
110
157
 
111
- 再次感谢其他优秀的项目给予灵感:gork codex、kimicli、Gemini、等优秀项目
158
+ 再次感谢其他优秀的项目给予灵感:pi、gork、kimicli、Gemini、ohmypi 等优秀项目。
112
159
 
113
160
  ---
114
161
 
115
- ## 入口
162
+ ## 🔗 入口
116
163
 
117
- https://scream.chat
164
+ 🌐 **官网**:https://scream.chat
118
165
 
119
- ## Star History
166
+ ---
167
+
168
+ ## ⭐ Star History
120
169
 
121
- <a href="https://www.star-history.com/?repos=LIUTod%2Fscream-code&type=date&legend=top-left">
170
+ <a href="https://www.star-history.com/#LIUTod/scream-code&Date">
122
171
  <picture>
123
- <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/chart?repos=LIUTod/scream-code&type=date&theme=dark&legend=top-left" />
124
- <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/chart?repos=LIUTod/scream-code&type=date&legend=top-left" />
125
- <img alt="Star History Chart" src="https://api.star-history.com/chart?repos=LIUTod/scream-code&type=date&legend=top-left" />
172
+ <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=LIUTod/scream-code&type=Date&theme=dark" />
173
+ <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=LIUTod/scream-code&type=Date" />
174
+ <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=LIUTod/scream-code&type=Date" />
126
175
  </picture>
127
176
  </a>
128
177
 
178
+ ---
179
+
180
+ ## 📄 License
181
+
182
+ [MIT](LICENSE) © [LIUTod](https://github.com/LIUTod)
129
183
 
130
- ## License
184
+ ---
131
185
 
132
- MIT
186
+ <p align="center">
187
+ Made with ❤️ by <a href="https://github.com/LIUTod">LIUTod</a>
188
+ </p>