nekomimi
v0.2.2
Published
Observable local coding agent with a durable request and tool journal
Maintainers
Readme
Nekomimi
一只住在项目里的编程小助手。用 DeepSeek 阅读代码、修改文件、运行命令,在浏览器中查看回答、文件差异和执行过程。
安装
需要 Node.js 22.19.0 或更新版本(包含 npm)。可从 Node.js 官网 安装。
支持 Node.js 22.19+ 和 24;Node.js 20 及 22.19 之前的版本不满足当前依赖要求。
npm install -g nekomimi开始使用
进入你想处理的项目目录,启动 Nekomimi:
cd /path/to/your-project
nekomimi web打开终端显示的本地链接,在左侧 设置 中保存 DeepSeek API key:
- 登录 DeepSeek 开放平台,创建 API key。
- 将密钥填入 Nekomimi 设置中的输入框,点击 保存 API key。
- 回到会话,输入任务。例如:
阅读这个项目,介绍它的结构,先不要修改文件。
无需克隆 Nekomimi 源码,也无需配置环境变量。当前版本使用 DeepSeek。主对话模型与地址可通过 CLI 配置;网页搜索可在设置中开关。
定制你的助手
可以让 Nekomimi 为项目编写工具、命令或工作流程,例如:“创建一个 /review 命令,按项目规范审查改动,并显示结果卡片。”它可以读取随包 SDK 资料、生成扩展、校验并修复。首次生成后,在顶部 定制能力 中信任并启用,再重载使用;后续修改在当前任务结束后生效。
Nekomimi SDK 统一提供本地 TypeScript 扩展、Skills、分层规则、MCP 工具与内容/OAuth、Provider、能力包、持久工作流、隔离面板及运行时主题与视图扩展。支持通过对话生成、校验、修复并启用定制能力;可信 Node 扩展的进程隔离不是 OS 沙箱。见 开发入口、运行时 UI 和 调试验收。
日常使用
- 发送任务:Enter 发送,Shift+Enter 换行;中文输入法 Enter 选词不会发送。
- 继续对话:在同一会话中发送后续要求。首轮完成后,会话会自动命名。
- 阅读代码:回答中的常用语言代码块、历史文件差异和离线 HTML 支持语法高亮,未知语言保留纯文本。
- 查看改动:工具卡直接展示增删行,右侧“变更”按会话列出 edit/write 的逐次修改。支持展开、分页和原始 patch;不包含 bash 或外部编辑器的未记录修改。
- 浏览文件:顶部“文件与变更”打开项目文件树。单击选择、双击文件(或 Enter)交给本机默认程序打开;隐藏项可切换,外部文件变化点击刷新。
- 网页搜索:默认启用 web_search,模型需要时调用 DeepSeek 服务端搜索,来源与部分结果状态可见;设置中可关闭。搜索有独立调用记录和用量,沿用本机 DeepSeek 凭证。
- 停止任务:点击“停止任务”。关闭浏览器不会自动取消任务。
- 删除会话:侧栏“•••”中选择删除,再确认。只删除会话记录,保留项目文件。
- 导出:可导出离线 HTML;分享前检查内容,并按需填写脱敏文本。
停止服务请回到终端按 Ctrl+C。下次在同一项目目录运行 nekomimi web,即可查看此前会话。服务重启后请使用终端新输出的链接。
项目与数据
在哪个目录启动,就处理哪个项目。 页面只显示当前工作区的会话,切换到另一个项目目录启动时,两边历史分别管理。
文件工具在当前项目范围内读写,命令的初始工作目录也是当前项目。Shell 使用你的系统权限执行,并不是系统沙箱;执行修改任务前,建议先提交或备份重要文件。
配置和会话保存在 ~/.nekomimi/,按项目路径区分,不写入 Nekomimi 安装目录。API key 保存在本机配置文件中,设置不会回显已保存密钥;无需设置 DEEPSEEK_API_KEY。移动项目目录后,会被视为新的工作区。
更新与卸载
npm install -g nekomimi@latest更新前先停止正在运行的服务。
npm uninstall -g nekomimi卸载不会删除项目文件或 ~/.nekomimi/ 中的配置和历史。
常见问题
找不到 nekomimi 命令? 检查 node --version 和 npm --version,重新打开终端,并确认 npm 全局可执行目录已加入 PATH。安装权限问题可参考 npm 官方说明。
提示未配置或认证失败? 在设置中保存或替换有效的 DeepSeek API key,并检查开放平台账户状态。
无法打开页面或提示未授权? 使用终端打印的完整链接。需要换端口时运行 nekomimi web --port 3001。
提示工作区正在使用? 同一工作区只运行一个服务或任务实例。停止旧实例后重试;异常退出后可能需要等待锁租约过期。
文件无法打开? 打开的是运行 Nekomimi 服务的机器上的当前文件。请检查文件是否存在、系统默认程序关联及桌面环境;界面“已提交”表示打开请求已交给系统。文件打开仅对当前项目普通文件可用。
支持哪些系统? 当前重点支持和验证 macOS、Linux,发布检查覆盖这两个平台的 Node.js 22.19.0/24.15.0。Windows 暂不执行 CI/CD 检查,待 macOS/Linux 稳定后再统一优化和恢复原生验证;暂不保证当前版本在 Windows 上的完整体验。历史结果见 版本发布记录。
开发与文档
上下文占用与压缩
输入框旁的圆环可查看当前请求的系统提示词、工具定义和对话占用估算(~),并非累计账单。默认接近模型容量时自动整理早期内容;可在设置中关闭。发送 /compact 或 /compact 保留未完成任务和文件路径 可手动整理,点击停止可取消。摘要可能丢失细节并产生额外模型费用,全部原始记录仍可查看和导出;失败或取消不改变有效上下文。容量未知时只显示估算,不能安全整理时会提示处理。
详细口径、预算、Provider 和 SDK 边界见 上下文说明。
nekomimi web 启动成功后自动打开带连接信息的浏览器页面;远程终端、自动化和无图形环境请使用 nekomimi web --no-open。自动打开失败不会停止服务,可手动访问终端输出的 Web 地址。程序化 startWeb() 不会打开浏览器。
