neko-harness 0.2.6 → 0.2.7

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.
Files changed (8) hide show
  1. package/README.md +33 -38
  2. package/dist/client/assets/{index-i2RX8_Dz.js → index-B-Vl0yXY.js} +3 -3
  3. package/dist/client/assets/index-BwqDUlvt.css +2 -0
  4. package/dist/client/index.html +2 -2
  5. package/dist/gateway.js +1 -1
  6. package/dist/neko.js +1 -1
  7. package/package.json +1 -1
  8. package/dist/client/assets/index-CTU5YVxz.css +0 -2
package/README.md CHANGED
@@ -1,87 +1,82 @@
1
1
  # neko-harness
2
2
 
3
- 在终端或浏览器中使用的本地 AI 编程助手。支持工作区与会话管理、文件读写、命令执行、图片输入、网页搜索和技能调用，默认使用 DeepSeek V4.1 Flash，思考强度为 high。
3
+ 在终端或浏览器中使用的本地 AI 编程助手。支持文件读写、命令执行、图片输入、网页搜索和技能调用，会话自动保存。
4
4
 
5
5
  ## 安装
6
6
 
7
- 需要 **Bun 1.4.2 或更新的 1.4.x 版本**。当前支持 macOS 和 Linux。
7
+ 支持 macOS 和 Linux，需要 **Bun 1.4.2 或更新的 1.4.x 版本**。
8
8
 
9
9
  先按 [Bun 安装说明](https://bun.sh/docs/installation)安装 Bun，然后运行：
10
10
 
11
11
  ```bash
12
12
  bun add --global neko-harness
13
- neko --version
14
13
  ```
15
14
 
16
- 如果找不到 `neko` 命令，请将 Bun 的全局可执行目录（通常是 `~/.bun/bin`）加入 `PATH`。
17
-
18
- `@` 文件与目录补全使用随包提供的 Pi 1.2 本地文件发现组件，无需安装 fd/fdfind。
19
- 候选遵守 Git 工作树的忽略规则；非 Git 目录不应用 `.gitignore`，均不读取 `.ignore`/`.fdignore`。包含未被忽略的隐藏项并排除 `.git`。
20
- 网关共享有界目录缓存，文件变化使缓存失效，最长 30 秒后按需刷新；结果不完整时可指定子目录缩小范围。发现组件异常时可以重试查询，普通消息仍可发送。
15
+ 如果找不到 `neko` 命令，请将 `~/.bun/bin` 加入 `PATH`。
21
16
 
22
17
  ## 开始使用
23
18
 
24
- 进入你要处理的项目目录，选择一种界面：
19
+ 进入项目目录，启动终端或浏览器界面：
25
20
 
26
21
  ```bash
27
22
  cd /path/to/your/project
28
23
  neko tui
29
- # 或打开浏览器界面
24
+ # 或
30
25
  neko web
31
26
  ```
32
27
 
33
- Web 默认自动打开 `http://127.0.0.1:8322`。两种界面都会按需启动本地网关，无需另行启动服务。
28
+ Web 会自动打开浏览器。两种界面可以同时使用，无需额外启动服务。
34
29
 
35
- macOS/Linux 上默认网关同时监听 Unix socket 和 WebSocket（`127.0.0.1:8321`），TUI 与 Web 可以按任意顺序启动并共享网关。后启动的界面退出时不会停止已有网关。
36
- 如果已有网关使用自定义 WS 端口，启动 Web 时使用匹配的 `--gateway-port`（例如 `neko web --gateway-port 8331`）。
37
- Web 会验证 WS 连接及网关身份；若旧版 TUI 拉起的网关未启用 WS，请先正常退出拥有网关的界面，再重新启动。Web 不会自动重启正在运行的网关。
30
+ 首次使用，在 TUI 输入 `/login`，或打开 Web「设置 → 密钥」，填入 [DeepSeek API Key](https://platform.deepseek.com/api_keys)。默认使用 DeepSeek V4.1 Flash，也可在界面中切换模型。
38
31
 
39
- 首次使用，在 TUI 输入 `/login`，或打开 Web 设置页，填入 [DeepSeek API Key](https://platform.deepseek.com/api_keys)。也可以在启动前设置环境变量：
32
+ 也可以通过环境变量提供 Key：
40
33
 
41
34
  ```bash
42
35
  export DEEPSEEK_API_KEY='你的 API Key'
43
36
  neko tui
44
37
  ```
45
38
 
46
- 界面保存的 Key 优先于环境变量；删除已保存 Key 后恢复使用环境变量。Key 保存在本机 `~/.neko/credentials.json`，请勿分享此文件。
39
+ 界面保存的 Key 优先于环境变量，并保存在本机，请勿分享。
47
40
 
48
41
  ## 日常操作
49
42
 
50
- - **工作区**：默认使用启动目录；可通过 `neko tui --cwd /path/to/project` 或 `neko web --cwd /path/to/project` 指定。Web 也可添加目录并切换工作区。
51
- - **会话**：TUI 输入 `/sessions` 切换会话；Web 使用侧栏。会话自动保存。
52
- - **模型与思考强度**：TUI 使用 `/model` 和 `/think`；Web 点击聊天区的模型选择器。
53
- - **文件引用**：输入 `@`，选择工作区中的文件或目录。
54
- - **图片**：TUI 使用 `Ctrl+V` 粘贴剪贴板图片；Web 支持粘贴、拖放和选择图片。是否能够识图取决于当前模型。
55
- - **仅图片输入**：没有文字说明时，neko 会为一张或多张图片附上默认用户提示，优先结合对话任务，否则说明关键信息并询问意图。提示与图片一起保存，不修改系统提示词；带文字的图片消息不补词。点击消息上的默认图片提示标记可展开查看。旧图片历史保持原样。
56
- - **压缩上下文**：输入 `/compact`。内容不足以压缩时会显示提示。
57
- - **技能**：输入 `/skill:` 选择技能。技能从 `~/.agents/skills/` 和工作区 `.agents/skills/` 加载。
58
- - **网页搜索**：默认使用有速率限制的 Tavily 免 Key 模式；也可在凭据设置中配置自己的 Key，或使用 `TAVILY_API_KEY` 环境变量。
43
+ - **工作区**：默认使用启动目录，Web 可在侧栏添加和切换项目。
44
+ - **会话**：TUI 用 `/new` 新建、`/sessions` 切换；Web 使用侧栏。
45
+ - **模型与思考强度**：TUI 使用 `/model` 和 `/think`；Web 点击输入框中的模型入口。
46
+ - **文件与目录**：输入 `@` 选择引用。
47
+ - **图片**：TUI 用 `Ctrl+V` 粘贴；Web 支持粘贴、拖放和选择图片。识图能力取决于所选模型。仅发送图片时会自动补充简短提示，可点击消息中的「默认图片提示」查看。
48
+ - **压缩上下文**：输入 `/compact`，整理较长的对话。
49
+ - **技能**：输入 `/skill:` 选择；Web 可从侧栏进入技能市场，浏览和安装技能。
50
+ - **网页搜索**：默认可直接使用；如需使用自己的 Tavily Key，可在密钥设置中配置。
59
51
 
60
- 工作区用于组织会话和确定默认目录，**不是文件访问沙箱**；助手可以执行命令和修改文件，请在可信项目中使用。
52
+ 助手可以执行命令和修改文件，请在可信项目中使用；工作区目录不限制助手的文件访问范围。
61
53
 
62
- ## 常用选项
54
+ ## 常用设置
63
55
 
64
56
  ```bash
65
- neko web --port 8333 # 更换网页端口
66
- neko web --no-open # 启动后不打开浏览器
67
- neko tui --theme dark # 使用深色终端主题
68
- neko serve # 独立运行网关
69
- neko tui --help
70
- neko web --help
71
- neko serve --help
57
+ neko tui --cwd /path/to/project # 指定项目目录，Web 也支持
58
+ neko tui --theme dark # 使用深色终端主题
59
+ neko web --port 8333 # 更换网页端口
60
+ neko web --no-open # 启动后不自动打开浏览器
72
61
  ```
73
62
 
74
- 本地数据默认保存在 `~/.neko/`，会话数据库为 `neko.sqlite`。退出界面不会删除会话。备份数据前请先停止正在使用该目录的 neko 进程。
63
+ 更多选项见 `neko tui --help` 和 `neko web --help`。
64
+
65
+ 会话与设置保存在 `~/.neko/`，退出不会删除。备份前请先退出所有 neko 界面及服务；备份可能包含 API Key，请妥善保管。
75
66
 
76
- 升级：先完成任务，退出使用同一数据目录的 TUI/Web 和独立 `neko serve`，然后执行：
67
+ ## 升级
68
+
69
+ 先完成任务，退出正在运行的 neko 界面及服务，然后执行：
77
70
 
78
71
  ```bash
79
72
  neko update
80
73
  ```
81
74
 
82
- 升级后重新运行 `neko tui` 或 `neko web`。TUI `/version` 和 Web 设置中的「关于与更新」可查看版本、检查更新。界面只提示，不自动安装或重启；仅页面需要更新时使用刷新入口，文字草稿会保留，有未发送附件时先发送或移除。源码、项目局部或链接安装请按原方式更新。
75
+ 完成后重新运行 `neko tui` 或 `neko web`。
76
+
77
+ TUI 输入 `/version`，或打开 Web「设置 → 关于与更新」，可查看版本、检查更新。界面会提示何时需要升级、重启或刷新，由你手动操作。
83
78
 
84
- 发布包的产品版本来自根 manifest，独立于 Pi 依赖和 workspace 包版本。后台检查稳定渠道缓存 24 小时，离线不影响聊天；安装版本单独检查，升级后仍运行的旧网关会提示重启。
79
+ 如果当前版本没有 `neko update` 命令，可重新运行 `bun add --global neko-harness`。
85
80
 
86
81
  ## 许可证
87
82