neoctl

中文文档
0.2.59发布于 2026/11/04TypeScriptES Module

带有REPL UI层的流代理运行时的TypeScript脚手架。

中文使用文档
文档目录3 节
  1. 安装使用
  2. 模型配置
  3. 源码开发

Neo Engine

Neo 的 TypeScript 核心运行时,提供 neo 命令行、模型调用、工具执行、会话管理和子代理任务。Web 和 Desktop 共用这套核心。

子代理调度及管理工具(subagent_run/output/list/get/stop/message/resume)默认开放;系统提示词默认要求仅在用户明确要求时委派子代理。Web/Desktop 可在工具设置中关闭,会话设置可覆盖全局设置;已有明确保存的设置保留。SDK 使用者可通过 ToolRegistry.setEnabled(name, false) 显式关闭。子代理内部的 subagent_report 汇报通道及禁止嵌套委派的限制保持不变。

安装使用

需要 Node.js 20+。

npm install -g neoctl
neo

首次使用输入 /login 配置模型。常用命令:

neo -help                  # 查看帮助
neo run "总结当前仓库"       # 执行一次任务
neo -web                   # 打开核心自带的 Web 界面

对话中可用 /new 新建会话、/sessions 查看历史、/compact 压缩上下文。

模型配置

支持 OpenAI 兼容的 Responses 和 Chat Completions 接口。除交互配置外,也可在工作目录的 .env 中填写:

MODEL_PROVIDER=openai
OPENAI_API_KEY=your-api-key
OPENAI_BASE_URL=https://api.openai.com
OPENAI_MODEL=your-model-name

将密钥和模型名替换为实际值。NEO_ENV_FILE 可指定其他配置文件。

源码开发

在 engine/ 目录执行:

npm ci
npm run dev
命令用途
npm run build编译源码到 dist/
npm start运行已构建的 CLI
npm run typecheck检查源码和测试类型
npm test运行单元测试
npm run standalone构建当前平台的便携分发目录

源码位于 src/,测试位于 tests/。便携构建输出到 standalone/<平台>-<架构>/。

更多测试命令见 tests/README.md。

版本与发布记录

neoctl 共发布 81 个版本,首次发布于 2026/05/08;过去 12 个月发布了 81 个版本。

版本发布日期距今
0.2.59latest2026/11/04今天
0.2.582026/11/04今天
0.2.572026/11/031 天前
0.2.562026/11/031 天前
0.2.552026/11/031 天前
0.2.542026/11/031 天前

关于 neoctl 的常见问题

neoctl 是什么?

带有REPL UI层的流代理运行时的TypeScript脚手架。

如何安装 neoctl?

在项目目录运行 npm install neoctl,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 neo,可以用 npx neo 直接运行。

neoctl 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

neoctl 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

neoctl 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=20。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

neoctl 可以商用吗?

neoctl 使用 未声明 许可。package.json 没有声明许可证。没有许可证的代码默认保留全部权利,商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括,不构成法律意见,请以许可原文为准。

neoctl 还在维护吗?

最新版本 0.2.59 发布于 2026/11/04(今天);至今共发布 81 个版本,其中过去 12 个月发布了 81 个;首次发布于 2026/05/08。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。