Skip to content

Latest commit

 

History

History
155 lines (131 loc) · 10.6 KB

README.zh.md

File metadata and controls

155 lines (131 loc) · 10.6 KB

Scream Code

一款本地 Agent,无任何远程数据行为。用它自由写代码、跑任务、查资料,coding 或 working随你发挥。

npm downloads stars license

English | 简体中文

企业微信20260909-170226@2x


安装

npm install -g scream-code

Note

要求 Node.js >= 22,建议安装 Git。安装与更新都是同一条命令;无需任何本地编译、也不执行依赖的安装脚本,向量引擎跑在 WebAssembly 上。 首次使用知识库/记忆的向量功能时会自动下载约 53MB 的模型到 ~/.scream-code/cache(有进度显示,下载完成后校验哈希再启用)。

快速开始

scream            # 终端 TUI
scream --auto     # 自动权限模式
scream -y         # 自动批准模式

首次启动会自动进入模型配置向导(/config,先选择配置方式:快捷选择模型提供商 / 自定义Diy配置模型商 / 生图能力模型配置)。内置 130+ 模型商,或用 /config diy 指向任意 OpenAI 兼容端点。配置后用 /model 随时切换,无需重启,亦或者通过 /model diy 为子Agent 配置不同的模型,让模型去做最擅长的工作。生图同理:先跑一次 /config image 配置生图服务,之后直接说「画一张」即可(/image 技能)。

当它要修改文件或执行命令时,会弹出审批面板:按数字键选择,回车确认。

核心特性

  • Goal Loop — 目标自主驱动,独立裁判 Agent 裁决:打回必须指出具体缺口;缺证据可自动修(上限 3 轮),主观事项直接挂起等你决策(附书面报告);支持轮次/Token/时间预算控制。
  • TUI 侧边栏 — 五段实时面板:工作区 Git 摘要(绿色新增/红色删除)、会话 Token 分桶(缓存命中/未命中/输出)、9 个 Agent 槽位实时状态(休息中/工作中/输出中/交谈中/返工中/求助中)、Goal 状态与裁判状态(等待中/裁定中/已裁定),以及网络 Hub(当前模型商实测响应时间 + 常用端点往返延迟;仅在侧栏可见时探测,每 30 秒一次)。
  • Wolfpack 群狼模式 — 无限制并行子 Agent(coder / explore / plan / verify / reviewer / oracle / writer / worker / designer)。
  • 子代理协作 — 把任务交给专职子代理,运行中也能随时指挥:受阻时会主动找主 Agent 商量而不是瞎猜,需要时请求换擅长的人接手;支持发送即时调整指令或补充说明、要求 JSON 结构化输出;还能限制为「只读 / 仅编辑 / 可执行命令」安全模式,防止越权。
  • Bot 无人值守模式(/bot) — 你离开也能干活:可逆操作(读、工作区内改代码、只读命令)自动执行;不可逆操作(推代码 / 发布 / 删除 / 敏感文件 / 未分类命令)自动拒绝并排队等你审——拒绝理由会告知模型,避免盲目重试。
  • 永久记忆备忘录 — 痛点记忆结构化 SQL 提取,FTS5 全文 + Tag 语义 + 向量三重检索,跨会话共享,越用越懂你。
  • 本地 SAG 知识图谱 — 基于 SAG 论文(arXiv:2606.15971)的可视化知识库,大幅提升多跳推理,随时导入本地知识。
  • RLM 模式 — 面向长任务的持久 Python 工作环境,状态跨调用保留;rlm() 直接由代码派生递归子代理(固定走 coder profile),深度默认无限、可用 /rlm-max-depth 限制。每次 rlm() 都是一次真实子代理运行,会消耗 token。
  • 脚本模式 — 默认开启:模型可在沙箱里跑 JavaScript 帮它批量调用其他工具,几十个文件/页面的活一次跑完,只有脚本的汇总结果进入对话;/script 切换开关。
  • 会话轨迹 /trace — 将会话导出为自包含、离线的交互式 HTML 时间轴(含工具调用、JSON 导出)。
  • 上下文搜索 /search — 全屏关键词搜索(等同 Ctrl+Shift+F),输入即过滤,Esc 关闭。
  • 高缓存命中率 HitR — 状态栏会话级命中率,适配多种兼容协议,工作不降智的情况下最大化优化了缓存命中率。
  • MCP / Skill / 130+ 模型商 — 全部可 DIY 配置;内置浏览器自动化与 macOS 桌面自动化。
  • 自进化插件系统 — 内置 ManagePlugin 工具,让 Agent 自行检索/自制/安装技能与 MCP 服务器,装入即对当前会话热生效;安全兜底:代码入口需单独批准激活、熔断自动摘除、免疫记忆在重复安装前提示历史、升级保留一键回滚备份。
  • 多渠道远程控制 — 通过 cc-connect 打通微信、飞书、Slack、钉钉、QQ、Telegram、Discord。

斜杠命令

输入框输入 / 即可浏览全部 55 个命令:

指令 说明
模式与执行
/auto 切换自动权限模式
/yes(/yolo) 切换自动批准模式
/ask 切换只读问答模式
/bot 无人值守 Bot 模式:可逆操作自动执行,不可逆的停下等你审
/goal [目标] 查看/管理自动目标(目标驱动循环)
/wolfpack(/wp) 切换群狼协作模式,自动批准+批量并发
/rlm RLM 模式:持久 Python 工作环境,rlm() 派生真实递归子代理(coder profile)
/rlm-max-depth [N] 查看/设置 RLM 递归深度上限(0 = 无限,默认为无限)
/script 脚本模式:在沙箱中运行 JavaScript 批量调用工具(默认开启)
/plan 切换计划模式
/fusionplan(/fp) 切换融合计划模式(多子代理并行规划)
/btw 在不中断对话的情况下快速提问
/eval 运行端到端测试(Agent健康度检查)
会话
/new(/clear) 在当前工作区开启新会话
/sessions(/resume) 浏览并恢复会话
/compact 压缩对话上下文
/fork 复制当前会话并新开分支
/title(/rename) 设置或显示会话标题
/revoke [N] 撤回上一次对话(如 /revoke 3)
/export-md(/export) 导出当前会话为 Markdown
/export-debug-zip 导出当前会话为调试 ZIP 存档
/status 显示当前会话和运行时状态
/usage 显示 token 用量和上下文窗口
记忆与知识
/memory(/memo、/mem)[查询] 浏览、搜索、注入记忆备忘录
/knowledge(/know)[查询] 管理本地知识库(摄入/搜索/删除/统计)
模型与配置
/model [别名] 切换 LLM 模型
/config (/login) 配置模型服务:快捷选择模型提供商 / 自定义Diy配置模型商 / 生图能力模型配置
/config image 配置生图(服务商 / URL / 密钥 / 模型,首次配置)
/logout(/disconnect) 删除已配置的模型
/language(/lang) 切换界面语言
/theme 设置终端 UI 主题
/permission 选择权限模式
/grants 查看并撤销本会话的审批授权
/editor 设置外部编辑器
/settings 打开 TUI 设置
/init 分析代码库并生成 AGENTS.md
/update 手动更新 Scream Code 到最新版本
/version 显示版本信息
扩展
/mcp 管理 MCP 服务器(安装/停用/卸载)
/skill(/skills、/plugin) 技能中心,管理 Skill 技能,含激活、安装、卸载等
/extension 代码扩展:激活或停用插件入口
/make-skill 从当前会话沉淀工作流为 Skill
/image 画图 / 改图(image 技能;先用 /config image 完成一次配置)
/cc 操控你的 cc(启动/关闭/重启)
/cc-connect cc-connect 快速通道配置
工具
/search 上下文关键词搜索,ESC 关闭
/trace 查看会话工作轨迹
/hl(/highlight) 开关用户消息高亮块
/blockrows 调整活动块行数(折叠高度 / 工具结果行数 / 思考行数)
/codebg 开关代码块背景色面板
/mermaid 选择 Mermaid 块的渲染方式:用制表符边框画成图 · 照样画但边框改用 ASCII 字符(终端把制表符画成两格宽时用) · 不画、保留源码
/snaptimer(/timer) 开关会话快照计时器(每回合耗时标记)
/sidebar 打开/关闭侧边面板(Ctrl+X 快速开关)
/tasks(/task) 浏览后台任务
/cron 定时任务:列表、新建(选时间 + 输入任务)、删除
/like 设置你的偏好(昵称、语气、其他偏好)
/help(/h) 显示可用命令和快捷键
/hotkeys(/keys) 查看键盘快捷键
/copy(/yank) 复制上一条回复到剪贴板
/exit(/quit、/q) 退出应用

常用快捷键: Ctrl+S 中断 · Ctrl+C 取消 · Ctrl+O 展开工具输出 · Ctrl+Shift+F 搜索 · Shift+Tab 计划模式 · Shift+Enter 换行 · Tab(空输入)切换思考强度 · @ 提及文件

文档

官网:https://scream.chat

  • 自进化实测手册 — 从自制技能、安装、激活、熔断到回滚的完整演练:packages/agent-core/docs/self-evolution-e2e.md。

致谢

完全免费、开放使用,欢迎魔改与反馈。Scream 是一个轻量化 Agent 底座——最大化释放模型本身的能力,不做过度的框架约束。


GitHub · scream.chat · MIT License · Made with ❤️ by LIUTod