快速开始与配置
安装方式、终端与浏览器启动、模型向导与兼容端点配置。
阅读快速开始GET STARTED 文档与快速开始
准备项目与模型配置,给出一个小目标,再检查第一次交付。这里是实用起点,完整指令与最新变化请以仓库文档为准。
01 安装与启动
准备 Node.js 22.19+,建议安装 Git。模型调用需要你自己的服务配置;使用本地模型时,需要提供兼容接口。
your-project 换成已有项目的实际路径。首次启动会进入模型配置向导;在工作区内启动,有助于为 Agent 提供正确的项目上下文。01 安装(更新也使用同一命令)
$npm install -g scream-code02 进入已有项目
$cd your-project03 启动终端
$scream或 启动浏览器入口
$scream webhttp://localhost:3210,仅在本机开放。/config首次启动进入配置向导,按提示选择服务、提供密钥与模型。已经启动后,也可输入 /config 重新配置。
/config diy自行指定 OpenAI 兼容服务地址与对应配置。使用本地模型时,确认服务已启动并提供兼容接口。
/model运行中切换已配置的模型,无需重启。需要为子 Agent 选择不同模型时,使用 /model diy 按提示配置。
/permission / /grants默认修改文件与执行命令需要审批。选择适合任务的权限模式,审批前阅读操作内容;/grants 可查看与撤回当前会话授权。
03 第一次任务
从只读理解任务开始,先检查上下文与项目判断,再让 Agent 推进具体改动。
“先阅读这个项目,概括目录结构、技术栈与启动方式,列出你不确定的地方。先不要修改文件。”
对照项目文件确认结构与启动方式,检查未确定事项是否合理;有误时补充上下文。
例如补充一段安装文档,或定位一个可复现问题。说明允许改动的范围与预期产出。
在审批面板阅读文件修改或命令,确认后再授权;任务中可以随时补充说明。
检查改动、验证结果与剩余问题。需要自动目标循环时,用 /goal 管理目标,并给出明确完成判据。
| 指令 | 作用 |
|---|---|
/help | 查看命令与快捷键。 |
/config/model | 配置模型,或切换已配置的模型。 |
/permission/grants | 选择权限模式,查看与撤回授权。 |
/goal | 查看与管理目标循环。 |
/sessions/new | 恢复会话,或在当前工作区新建会话。 |
/memory/knowledge | 查询记忆,管理本地知识库。 |
/mcp/skill | 管理工具服务与技能。 |
/trace | 查看或导出会话工作轨迹。 |
常用快捷键:Ctrl+S 中断,Ctrl+O 展开工具输出,@ 提及文件。完整行为与当前版本以应用内帮助和仓库说明为准。
05 深入阅读
直接到维护中的仓库文档。
安装、操作、扩展与版本变化各有入口。
安装方式、终端与浏览器启动、模型向导与兼容端点配置。
阅读快速开始Goal Loop、编队、记忆、工具与模式,以及会话与配置指令。
阅读核心特性 查阅斜杠命令从制作技能、安装和激活,到熔断与回滚的完整演练。
打开实测手册跟进版本发布;遇到问题时提供复现步骤、环境与必要日志。
查看版本发布 提交或查找问题检查服务地址、密钥、模型名称与网络;自定义端点需符合兼容接口。使用本地模型时,确认服务已运行。可通过 /config 重新配置,反馈问题时避免提供密钥等敏感信息。
确认安装命令执行成功,Node.js 与 npm 可正常运行,并检查 npm 的全局命令目录是否已加入 PATH。打开新的终端再试;仍有问题时在 Issues 提供系统、Node.js 版本与安装日志。
Agent、会话与记忆由本机管理。Scream 核心不做遥测或用户数据回传,模型请求只发送到你配置的 API;你主动启用的 MCP、生图与其他扩展可能访问相应服务。
默认只绑定 127.0.0.1。局域网访问需显式使用 --lan,并配置网关密钥;开始前请查看应用内 scream web --help 和当前版本说明。
用上下文、约束与完成判据,开始一次可审阅的协作。