Skip to content

start.md

Latest commit

 

History

History
52 lines (29 loc) · 5.54 KB

start.md

File metadata and controls

52 lines (29 loc) · 5.54 KB
Raw

启动与运行

← 文档目录 · English

零依赖：仅需 Node.js 22 或更高版本，无需安装 npm 包，所有前端库随项目本地分发，不加载在线资源

快速开始

双击 start.cmd，或在项目目录运行：

npm start

浏览器会打开 http://127.0.0.1:8787。首次使用时，在「设置 → 模型」中填写显示名称、模型 ID、Base URL 与 API Key 即可开始；项目不会读取或内置开发者电脑上的任何配置。可以添加多个接口并切换默认模型；每个模型可选「接口」是 OpenAI 兼容（chat/completions）还是 Anthropic（Messages API），Base URL 带 anthropic.com 的不选也认。

界面语言在「设置 → 通用 → 语言」里切换（中文 / English），切换后页面重新载入；没选过的随浏览器语言，中文系用中文，其余用英文。英文界面只换界面上的字，给模型的提示词照旧；「设置 → 文档」暂只有中文。

「设置 → 通用 → 桌面通知」默认关。开了之后，页面不在眼前时（切到别的窗口、别的程序），一答收尾、有事待你定夺（请示条、表单）、帮手断了待续，各弹一条系统通知；同一段对话的新通知顶掉旧的，点它回到那段对话。补言另起了一问、帮手还在做的，这段对话还没歇，不报；人按停的也不报。准许是各浏览器自己记的，头一回点「开」时浏览器会问；设置随存储目录同步，换了浏览器没准许就不弹，回来再点一次「开」即可。

start.cmd 打开的 CMD 窗口即本机桥接进程，必须保持开启；关闭后已加载的页面暂时仍在，但刷新、模型转发、联网与执事都会停止。浏览器开了、页面却报「本机桥接已停止」时，先看这个窗口：桥接退出会停在那里并打出原因（端口被占、缺 node 等），不会一闪而过。

Windows 便携包

不想先装 Node 的，用便携包：解开是一个「言」文件夹，双击里面的 言.exe 即可，其余与上面一样。言.exe 不开窗口：桥接在后台跑，它再起的指令也不弹黑窗；关掉言的页面，桥接过 30 秒没人连回来、也没有后台指令在跑，就自己退出（刷新、重开浏览器都赶得上；后台指令照跑，跑完再退）；言已开着时再双击，只是打开页面。桥接的输出记在「言」文件夹里的 桥接.log（每次启动重写），桥接异常退出时会弹框给出最后几行。要看着终端调试，改用 start.cmd。包里带着官方 Node（node\，含 npm），言自己的文件与仓库里的一字不差；start.cmd 也认这个 node\，两者等价。自带的 Node 接在 PATH 末尾：模型跑的 node、npx 与「环境」里装的前端工具找得到它，系统已装了 Node 的仍用系统的。对话、卷宗、配置照旧在 ~/.yan/，换用便携包或换回源码都接得上。

言.exe 没有代码签名，头一回双击 Windows 可能提示「已保护你的电脑」，点「更多信息 → 仍要运行」即可。

打包：在仓库里运行 npm run pack，得 dist/yan-<版本>-win-x64.zip（旧版本的包随之删去，发过的在 GitHub Release 上）。要用到系统自带的 curl.exe、tar.exe 与 .NET Framework 4 的 csc.exe（Windows 10 / 11 都有）；Node 的版本写在 pack/pack.mjs 开头，压缩包按 nodejs.org 的校验和验过才用，换版本后整套测试用包里的 Node 跑一遍（dist\言\node\node.exe test/run.mjs）。启动器的源码是 pack/launcher.cs，图标 pack/icon.ico 由 icon.svg 画成。

在 VS Code 内使用

  1. 通过「终端 → 运行任务」执行「言：启动模型桥接」，并保持该任务终端开启。
  2. 用系统浏览器打开 http://127.0.0.1:8787。Simple Browser 以 iframe 嵌入页面，会被言的 frame-ancestors 'none' 策略阻止；桥接也不向扩展 Webview 来源开放执事接口。
  3. 在「设置 → 模型」中填写配置；可先点「获取列表」，再点「测试连接」；联网检索在「设置 → 工具」里测。

直接打开 index.html

言须经本机桥接打开：运行 start.cmd（或 npm start），用系统浏览器访问 http://127.0.0.1:8787。直接双击 index.html（file://）接不上桥接——桥接不认来源为 null 的页面（file:// 页面是它，别处网页嵌进来的沙箱 iframe 也是它，分不出来）。改过 src/ 或 styles/ 后刷新即生效（桥接按请求即时拼接，不落成文件）。

环境变量

  • YAN_PORT：更换桥接端口，默认 8787
  • YAN_HOME：直接指定存储目录（对话、卷宗、配置都在里面），默认 ~/.yan/；指定了它就不读也不写记着存储位置的 %APPDATA%\言\位置.json（测试用）
  • YAN_DEBUG=1：把每个请求与异常断开的连接打到控制台，页面报「Failed to fetch」「本机桥接已停止」时用它看请求到底有没有到桥接

本机桥接

server.js 与 server/ 是本机桥接（各段分工见代码结构与开发）：加载页面、转发模型请求、代模型执行联网检索与网页读取（拒绝访问本机与内网地址，IPv6 字面量与 IPv4 映射地址同样按此判；正文边读边截，最多只收 3 MB），以及执事模式的指令与文件操作。静态文件带 ETag 校验，改动后刷新即生效；控制台不会显示 API Key。

一次请求最多带 128 件工具定义，超过明确报错而不是悄悄截掉后面的。