DOCS · QUICKSTART

快速开始

新手友好,三分钟上手 Yunor:从安装到跑通第一个工作流。

安装

Yunor 提供两种形态,按需选择。

桌面版(Windows)

前往 桌面版 GitHub 仓库 获取最新安装包,按提示完成安装。

终端版

npm 全局安装后即可使用(一条命令):

$ npm i -g yunor $ yunor

环境要求:Node.js ≥ 18(终端版零第三方依赖);本地模型额外需要:GGUF 需 llama-server(llama.cpp);HF/safetensors 需含 transformers + torch 的 Python。

接入第一个模型

启动后输入 /模型 即可接入模型。三种接入方式任选。

方式一:环境变量接入(最省事)

设好环境变量后启动,yunor 会自动接管并写回配置:

# PowerShell 接入 DeepSeek $env:OPENAI_BASE_URL = "https://api.deepseek.com" $env:OPENAI_API_KEY = "sk-..." $env:OPENAI_MODEL = "deepseek-flash" yunor

也支持 ANTHROPIC_BASE_URL / ANTHROPIC_AUTH_TOKEN / ANTHROPIC_MODELYUNOR_*

方式二:/模型 弹窗接入

  • 在线 API:填地址(如 https://api.deepseek.com)、Key、模型 ID
  • 本地模型:扫描目录,自动识别 *.gguf 或含 config.json + safetensors 的 HF 目录
  • 列表里的模型可选中使用 / 删除

方式三:本地大模型

本地模型需要本机 Python 3.11(含 transformers + torch)。GGUF 走 llama.cpp,无需 Python。

  1. /python 选择本机 Python 3.11 解释器(本地 HF 模型与 AI 的 Python 操作都用它)
  2. /模型 → 「+ 本地模型」→ 扫描目录 → 接入

第一次对话

❯ 帮我在这建一个 todo.md,写三条待办 ▌ yunor · 1.2s ▌ ✻ 思考 ▌ ✻ 需要先创建文件,用 write_file 工具 ▌ ✦ 回答 ▌ 好的,我来创建。 ▌ ▸ write_file 写入文件 D:\work\todo.md (86 字节) 是否允许此操作? ❯ 允许执行 拒绝 ↑↓ 选择 ↵ 确定 ⎋ 取消 ▌ ▸ 完成:已写入 D:\work\todo.md(86 字节) ▌ 已在 D:\work\todo.md 写入三条待办。

按键:Enter 发送 · ↑ / ↓ 输入历史 · Esc / Ctrl+C 退出。

长期记忆

让 AI 越用越懂你。

保存记忆

/memory # 保存到「当前目录」或「所有目录(total)」 /memory list # 查看已保存的记忆,可选中删除

记忆作用域

  • 当前目录:保存到 ~/.yunor/memory/<开启地址>.md,仅在该目录下注入
  • total:保存到 ~/.yunor/memory/total.md,所有目录都注入

记忆内容示例

# ~/.yunor/memory/total.md ## 全局偏好 - 默认使用中文回答 - 代码风格:4 空格缩进、snake_case 命名 - 不要在回答开头加「当然可以」等客套

电脑操作工具

模型可调用的工具,每次调用都先询问是否允许

工具作用
read_file读取文本文件
write_file创建 / 覆盖文本文件(自动建父目录)
append_file在文件末尾追加
make_dir创建目录(多级)
list_dir列出目录内容
move_path移动 / 重命名
copy_path复制文件或目录
delete_path删除文件或目录(递归)
open_path用系统默认程序打开文件 / 文件夹
run_python用选定 Python 跑代码

设计上刻意避免「什么都用 Python 干」:创建文档、读写文件这类操作都有原生工具,system prompt 也会要求模型优先用它们。

多终端并行

/多开 会在新的控制台窗口里再启动一个 yunor 进程,各自带一份独立配置YUNOR_CONFIG 指向临时配置文件),因此每个窗口可以接不同的模型、跑不同的会话。

  • 窗口数上限 4,用临时目录里的心跳文件统计在线数量
  • 除 yunor 窗口外,也可勾选拉起本机已装的其它命令行 agent

Python 选择

/python # 扫描并选择本机 Python 解释器

本地模型与 AI 的 Python 操作统一用它。yunor 会把选择持久化到 yunor.python.json

命令手册

命令作用
/模型弹出模型列表:切换 / 添加 / 删除
/python扫描并选择本机 Python 解释器
/工具 [on|off]电脑操作工具总开关(默认开;每次调用仍需确认)
/多开多开工作区
/memory保存会话习惯记忆
/memory list查看已保存的记忆
/thinking [on|off]开关思考段显示(默认开)
/help帮助

发布到 npm(维护者)

  1. package.json 里的 <YOUR_GH_USER> 换成你的 GitHub 用户名(repository / homepage / bugs
  2. 需要的话改 NAME(若 yunor 已被占用,改成 @你的scope/yunor
  3. npm loginnpm publish(首次可用 npm publish --access public

发布内容由 package.jsonfiles 白名单控制,只包含 bin/src/;含 API Key 的本地数据不会被打包,也已加入 .gitignore

安全说明

  • 所有电脑操作(文件读写、删除、运行代码)逐条确认,拒绝后模型会改为说明意图而不是重试
  • API Key 只存在本地 yunor.config.json / yunor.models.json,不联网上传
  • delete_path 会递归删除,确认框里会明确提示