# nexum-code

> A terminal-native AI agent for builders

Latest version **0.15.3** (published 2026-09-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install nexum-code
pnpm add nexum-code
yarn add nexum-code
bun add nexum-code
```

## Health

**Score 55/100 (C)** — status: active.

Positive: no vulnerabilities; recently updated; high maintenance score.

Warnings: low downloads; no types; no esm support; pre 1.0.

## Facts

| | |
|---|---|
| Version | 0.15.3 |
| Published | 2026-09-03 |
| First published | 2026-06-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | NexumCli |
| Maintainers | lwl0o0 |
| Keywords | agent, ai, cli, coding-agent, nexum, nexum-code, tui |

## Links

- npm: https://www.npmjs.com/package/nexum-code
- Repository: https://github.com/Hsssliu/nexum-code
- Homepage: https://github.com/Hsssliu/nexum-code/tree/main/apps/nexum-code#readme
- Issues: https://github.com/Hsssliu/nexum-code/issues
- npm.io page: https://npm.io/package/nexum-code

## Alternatives

- [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads
- [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads
- [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads
- [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads
- [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads

## Recent versions

- 0.15.3 (latest) — 2026-09-03
- 0.15.1 — 2026-08-31
- 0.14.7 — 2026-08-28
- 0.14.1 — 2026-08-22
- 0.13.5 — 2026-08-18
- 0.13.3 — 2026-08-14
- 0.12.8 — 2026-08-09
- 0.12.5 — 2026-08-07
- 0.8.1 — 2026-07-31
- 0.7.20 — 2026-07-08
- 0.7.19 — 2026-07-06
- 0.7.18 — 2026-07-06
- 0.7.17 — 2026-07-04
- 0.7.11 — 2026-07-01
- 0.7.10 — 2026-07-01
- … 5 more at https://npm.io/package/nexum-code/versions

## README

<p align="center">
  <img width="108" height="108" alt="Nexum Code" src="https://github.com/user-attachments/assets/26b707fa-1fd7-4dda-8484-e8c6b0bd7523" />
</p>

<h1 align="center">Nexum Code</h1>

<p align="center">
  <strong>一个真正为中文工作流设计的本地 AI Agent 工作台</strong>
</p>

<p align="center">
  不只是会写代码的终端助手。Nexum Code 把目标循环、长期记忆、多 Agent 协同、MCP 扩展、文档智能、后端 API 和远程聊天控制放进同一个本地运行的系统里，让 AI 可以稳定地替你执行复杂任务，也可以作为 Web 端智能体系统的底座。
</p>

<p align="center">
  <a href="https://www.npmjs.com/package/nexum-code"><img src="https://img.shields.io/npm/v/nexum-code?style=for-the-badge&logo=npm&logoColor=white&color=111827" alt="npm version"></a>
  <a href="https://www.npmjs.com/package/nexum-code"><img src="https://img.shields.io/npm/dm/nexum-code?style=for-the-badge&logo=npm&logoColor=white&color=2563eb" alt="npm downloads"></a>
  <a href="https://github.com/Hsssliu/nexum-code/blob/main/LICENSE"><img src="https://img.shields.io/github/license/Hsssliu/nexum-code?style=for-the-badge&color=0f766e" alt="license"></a>
  <a href="https://nodejs.org"><img src="https://img.shields.io/badge/Node.js-%3E%3D22-16a34a?style=for-the-badge&logo=node.js&logoColor=white" alt="node version"></a>
</p>

<p align="center">
  <a href="">官网</a>
  ·
  <a href="#快速开始">快速开始</a>
  ·
  <a href="#核心优势">核心优势</a>
  ·
  <a href="#能力地图">能力地图</a>
  ·
  <a href="#系统架构">系统架构</a>
  ·
  <a href="#web-端智能体底座">Web 智能体</a>
  ·
  <a href="#远程控制">远程控制</a>
  ·
  <a href="#部署指南">部署</a>
</p>

---

## 一句话介绍

Nexum Code 是一个本地优先的 AI Agent 系统。你可以用中文或英文直接下达目标，它会读取项目、编辑文件、运行命令、调用工具、拆分任务、记录记忆，并在需要时通过审批面板保护你的机器。它也可以通过后端服务和 Node SDK 接入 Web 产品，构建网页端智能体、工作台、自动化平台或企业内部 Agent 系统。

它适合这些场景：

- 写代码、改项目、跑测试、整理仓库
- 查资料、读文档、写报告、做研究
- 让多个子 Agent 并行处理复杂任务
- 把常用工作流沉淀成 Skill
- 接到自己的后端，做 Web 端智能体系统
- 通过微信、飞书、钉钉等聊天入口远程控制本地 Agent
- 解析 PDF、Word、Excel、图片等文档并提取结构化信息
- 连接数据库、浏览器、内部 API 等外部工具（MCP）

---

## 核心优势

<table>
  <tr>
    <td width="50%">
      <h3>目标驱动，不是空转循环</h3>
      <p>Nexum Code 内置 Goal 系统。你给出目标后，它会围绕目标持续推进，并由独立裁判判断是否完成，支持轮次、Token 和时间预算。</p>
    </td>
    <td width="50%">
      <h3>多 Agent 并行协作</h3>
      <p>Wolfpack 模式可以把复杂任务拆给多个子 Agent 并行执行。探索、编码、规划、验证、写作和办公自动化可以分工处理，适合多文件、多步骤的大任务。</p>
    </td>
  </tr>
  <tr>
    <td width="50%">
      <h3>长期记忆，不靠聊天记录硬撑</h3>
      <p>记忆系统支持 SQLite、FTS5 全文检索、Tag 归类和向量检索。它能跨会话保留偏好、约定、项目经验和反复出现的痛点。</p>
    </td>
    <td width="50%">
      <h3>本地运行，权限可控</h3>
      <p>文件写入、命令执行、敏感路径访问都会经过权限策略。默认安全，必要时可切换模式，让效率和控制感都在线。</p>
    </td>
  </tr>
  <tr>
    <td width="50%">
      <h3>MCP / Skill / 插件扩展</h3>
      <p>你可以连接数据库、浏览器、API、代码工具，也可以把自己的流程封装成 Skill。Nexum Code 更像一个可扩展的本地 Agent 底座。</p>
    </td>
    <td width="50%">
      <h3>可接后端和 Web 端</h3>
      <p>内置服务端 API 和 Node SDK，可以把会话、子 Agent、提示、取消、模型切换、权限控制等能力接入自己的 Web 应用。</p>
    </td>
  </tr>
  <tr>
    <td width="50%">
      <h3>中文体验优先</h3>
      <p>从配置、审批、提示到常用命令都围绕中文用户设计。不是把英文工具翻译一遍，而是从使用习惯上降低门槛。</p>
    </td>
    <td width="50%">
      <h3>终端、服务端、远程入口统一</h3>
      <p>同一套 Agent Core 可以跑在 TUI、后端服务和远程聊天入口后面。你可以先自己用，再把它产品化给团队使用。</p>
    </td>
  </tr>
  <tr>
    <td width="50%">
      <h3>🐍 RLM Mode</h3>
      <p><strong>A persistent Python workspace for long-running tasks</strong> — state survives across calls, kernels self-heal from crashes, and <code>rlm()</code> spawns unlimited recursive subagents (parent → child → grandchild…). Opt-in via <code>/rlm</code>, zero impact when off.</p>
    </td>
    <td width="50%">
      <h3>🧩 /rlm-max-depth</h3>
      <p><strong>Configurable recursion cap</strong> — unlimited by default; set a positive integer to bound the recursion chain, <code>0</code> for unlimited again.</p>
    </td>
  </tr>
</table>

---

## 快速开始

### 环境要求

- Node.js >= 22.0.0
- Git
- 一个可用的模型服务，例如 DeepSeek、OpenAI、Anthropic、通义千问、硅基流动或任何 OpenAI-compatible API

### npm 安装

```bash
npm install -g nexum-code
```

安装完成后，启动 Nexum：

```bash
nexum
```

### macOS / Linux 一键安装

```bash
curl -fsSL https://raw.githubusercontent.com/Hsssliu/nexum-code/main/install.sh | bash
```

### Windows PowerShell 一键安装

```powershell
irm https://raw.githubusercontent.com/Hsssliu/nexum-code/main/install.ps1 | iex
```

首次启动时，如果还没有配置模型，Nexum Code 会进入交互式配置向导。你也可以随时输入：

```text
/config
```

配置完成后，用下面的命令切换模型：

```text
/model
```

---

## 你可以怎么用

```text
帮我理解这个项目的架构，并指出最重要的入口文件
```

```text
修复 pnpm test 里的失败用例，改完后再跑一遍验证
```

```text
/goal 在不破坏现有 API 的前提下，把这套工具调用逻辑整理清楚，并补上必要测试
```

```text
/memory 记住：这个项目优先使用 pnpm，不要引入不必要的新依赖
```

```text
/wolfpack 帮我并行检查 README、安装脚本、CLI 参数和服务端 API 是否一致
```

```text
/document 解析这份 PDF 合同，提取关键条款和金额信息
```

```text
/mcp 连接本地数据库，帮我查询最近一周的订单数据
```

---

## 能力地图

| 能力 | Nexum Code 做什么 |
|---|---|
| 对话式执行 | 用自然语言描述任务，自动读文件、改代码、跑命令 |
| 审批面板 | 修改文件和执行命令前展示审批，降低误操作风险 |
| 权限策略 | 支持默认模式、计划模式、自动模式、YOLO 模式等 |
| Goal 循环 | 目标驱动的多轮执行，支持预算和完成度裁决 |
| 多 Agent | 子 Agent 并行处理探索、编码、验证、写作等任务 |
| 记忆系统 | 跨会话沉淀偏好、项目经验、问题记录和工作约定 |
| MCP 扩展 | 连接外部工具、数据库、浏览器、内部 API 等能力 |
| Skill 系统 | 把常用流程封装成可复用技能 |
| 插件系统 | 安装、扫描、注册插件，支持 GitHub 解析和源码加载 |
| 文档智能 | 解析 PDF、Word、Excel、CSV、图片，OCR 识别，结构化提取 |
| 知识库 | 管理知识条目，支持检索和复用 |
| LSP 支持 | 语言服务器协议客户端，代码编辑操作注册 |
| 后台任务 | 支持长任务、后台命令、Cron 定时任务和任务输出读取 |
| 会话管理 | 创建、恢复、分叉、导出（ZIP/Manifest）、历史记录和撤销 |
| 上下文压缩 | 全量/微压缩策略，自动管理长会话上下文 |
| 用量追踪 | Token 用量和成本统计 |
| 记录回放 | 执行记录持久化、迁移和回放 |
| 后端 API | 通过服务端接口创建会话、发送提示、控制 Agent 和读取状态 |
| Node SDK | 在自己的 Node 后端里集成 Nexum Agent 能力 |
| Web 智能体 | 可作为网页端 Agent 工作台、企业自动化系统或内部 Copilot 底座 |
| 远程聊天 | 通过 cc-connect 接入微信、飞书、钉钉、Slack 等平台 |
| 自动更新 | 多源更新（npm/GitHub/CDN）、版本选择、守护进程检查 |

---

## 系统架构

这个仓库是一个 TypeScript monorepo，核心模块大致如下：

```text
aiflowy-agent/
  apps/
    nexum-code/          # 终端入口与 TUI
    nexum-agent-server/  # Agent 服务入口（HTTP + SSE）
  packages/
    agent-core/          # Agent 循环、工具、权限、会话、MCP、LSP、Goal、记忆、RPC
    node-sdk/            # Node SDK 与 RPC 客户端
    nexum-server/        # HTTP API 与会话控制
    memory/              # 长期记忆、检索、整合、向量嵌入
    ltod/                # 模型与工具调用抽象
    jian/                # 本地运行时能力封装
    config/              # 共享配置与身份信息
    document-intelligence/  # 文档解析、OCR、提取、流水线
    knowledge/           # 知识库管理
    migration-legacy/    # 旧版数据迁移
```

关键设计思路：

- `agent-core` 负责 Agent 的大脑，包括工具注册、权限评估、执行循环、子 Agent、会话状态、MCP 连接、LSP 客户端、Goal 管理和记忆接口。
- `nexum-code` 负责终端用户体验，包括命令、审批面板、消息渲染、交互状态、自动更新和远程连接守护。
- `nexum-server` 和 `node-sdk` 让 Nexum 不只存在于终端，也能被后端服务、Web 应用、桌面端或其他客户端驱动。
- `memory` 独立成包，支持 SQLite、FTS5、向量检索和记忆整合，避免记忆能力被某一次会话绑定。
- `document-intelligence` 提供完整的文档处理流水线：类型检测、多格式解析、OCR、规则/大模型提取、验证和评估。
- `knowledge` 管理知识条目，支持跨项目复用。

---

## Web 端智能体底座

Nexum Code 不是只能在终端里跑。它的核心能力已经拆成可复用的服务端和 SDK 层，适合接入自己的产品后端。

你可以用它构建：

- Web 端 AI 编程助手
- 企业内部 Agent 工作台
- 自动化任务执行平台
- 多 Agent 协作系统
- 带记忆、权限和会话恢复的私有 Copilot
- 文档智能处理平台（PDF/Word/Excel 解析、OCR、信息提取）
- 持久 Python RLM 工作环境，支持递归子 Agent 与可配置深度
- 办公/文档自动化 Worker，支持格式转换、批处理和文件整理

后端可以围绕这些能力组织业务：

| 能力 | 适合做成什么产品功能 |
|---|---|
| Session API | 创建会话、恢复会话、分叉会话、导出会话 |
| Agent API | 发送任务、取消任务、切换模型、调整思考和权限模式 |
| Subagent Host | 在 Web 端展示多个子 Agent 的并行执行状态 |
| Permission System | 做企业级审批、敏感操作拦截和审计记录 |
| Memory Store | 做用户偏好、项目知识库和跨会话上下文 |
| MCP / Skill | 给 Web 产品接入数据库、浏览器、内部系统和自定义流程 |
| Document Intelligence | 文档上传、解析、OCR、结构化提取和批量处理 |
| Knowledge Base | 企业知识条目管理和检索 |

这意味着 Nexum Code 可以从"一个本地工具"升级成"你的 Agent 产品底座"：前端负责交互，后端负责业务权限和数据，Nexum 负责智能体执行、工具调度、记忆、多 Agent 编排和文档处理。

---

## 常用命令

| 命令 | 说明 |
|---|---|
| `/config` | 配置模型服务 |
| `/model` | 切换或管理模型 |
| `/memory` | 打开记忆管理 |
| `/dream` | 整理重复或过期记忆 |
| `/goal` | 开启目标循环 |
| `/wolfpack` | 开启多 Agent 协作 |
| `/cc-connect` | 配置聊天平台远程控制 |
| `/mode` | 查看或切换权限模式 |
| `/document` | 文档解析与提取 |
| `/knowledge` | 知识库管理 |
| `/mcp` | MCP 连接与工具管理 |
| `/skill` | Skill 技能管理 |
| `/plugin` | 插件管理 |
| `/export` | 导出会话 |
| `/compact` | 压缩会话上下文 |
| `/update` | 检查并更新 Nexum Code |
| `/agent` | Agent 相关操作 |
| `/session` | 会话管理 |
| `/experimental-flags` | 实验性功能开关 |

开发仓库时常用：

```bash
pnpm install
pnpm run dev:cli
pnpm run typecheck
pnpm run lint
pnpm run test
pnpm run build
```

---

## 远程控制

Nexum Code 可以通过 `cc-connect` 接入聊天平台。配置后，即使终端不在眼前，也能在聊天窗口里创建会话、发送任务、上传文件和切换模式。

```bash
npm install -g cc-connect
```

在 Nexum Code 中启动配置：

```text
/cc-connect
```

常用远程指令：

| 指令 | 用途 |
|---|---|
| `/new` | 创建新会话 |
| `/bind setup` | 开启文件传送，支持图片、PDF 等 |
| `/mode` | 查看可用模式 |
| `/mode yolo` | 自动批准所有工具调用 |
| `/mode default` | 每次工具调用前询问 |

---

## 部署指南

### Docker 部署（服务端）

`apps/nexum-agent-server` 是一个独立的 HTTP + SSE 服务端，支持容器化部署：

```bash
# 复制环境变量配置
cp .env.example .env
# 编辑 .env 设置 NEXUM_PORT 和 TOOL_GATEWAY_URL

# 启动服务
docker-compose up -d
```

docker-compose.yml 已配置健康检查、持久化卷和自动重启。

### 环境变量

| 变量 | 说明 | 默认值 |
|---|---|---|
| `NEXUM_PORT` | 服务端监听端口 | `3000` |
| `NEXUM_HOST` | 监听地址 | `0.0.0.0` |
| `NEXUM_HOME` | 持久化数据目录 | `/data/nexum` |
| `TOOL_GATEWAY_URL` | AIFlowy 工具执行回调地址 | 空 |
| `NEXUM_API_KEY` | API 密钥 | 空 |
| `NEXUM_MODEL` | 默认模型 | 空 |
| `NEXUM_BASE_URL` | 服务端点 | 空 |
| `NEXUM_MAX_TURNS` | 最大轮次 | 空 |
| `NEXUM_TEMPERATURE` | 温度参数 | 空 |
| `NEXUM_WORKSPACE` | 工作空间 | 空 |
| `NEXUM_LOG_LEVEL` | 日志级别 | 空 |
| `NEXUM_DISABLE_ANALYTICS` | 禁用分析 | 空 |
| `NEXUM_CACHE_DIR` | 缓存目录 | 空 |
| `NEXUM_CONFIG_DIR` | 配置目录 | 空 |

---

## 为什么做 Nexum Code

我想要的不是一个只会补全代码的工具，而是一个能长期陪我处理真实工作流的本地 Agent：

- 它要能记住项目里的约定，而不是每次从零开始。
- 它要能拆任务、分工、验证，而不是只会单线程聊天。
- 它要能接入我已有的工具和聊天入口，而不是把我锁在一个界面里。
- 它要能处理文档、提取信息，而不是只能读代码。
- 它要尊重本地机器的安全边界，而不是为了方便牺牲控制权。

所以 Nexum Code 选择了 TypeScript monorepo、本地优先、权限策略、长期记忆、多 Agent、MCP 扩展、文档智能和可扩展工具系统这条路线。它不是功能堆叠，而是把高频 Agent 工作流收敛成一个稳定的底座。

---

## 项目链接

- npm：https://www.npmjs.com/package/nexum-code
- 许可证：[MIT](LICENSE)

---

<p align="center">
  <strong>Nexum Code</strong>
  <br />
  Local first. Agent native. Built for real workflows.
</p>

---
_Source: https://npm.io/package/nexum-code · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
