# @compass-ai/nova 中文文档

规范地址：https://npmcn.com/package/%40compass-ai/nova/

版本：1\.1\.65
npm 元数据更新时间：2026-11-09T01:04:55.982Z
中文译文更新时间：2026-11-10T13:34:22.346Z
软件包许可：SEE LICENSE IN LICENSE

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40compass-ai/nova
原文对照：https://npmcn.com/package/%40compass-ai/nova/?lang=original
项目主页：https://dev.azure.com/oakpeak-devops/Kore
源码仓库：https://dev.azure.com/oakpeak-devops/Kore/_git/Kore-CLI

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：88.4 MB，2457 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=22\.13\.0
- 运行依赖：38 个
- peer 依赖：pg ^8\.13\.0，mssql ^11\.0\.1，mysql2 ^3\.11\.0，better-sqlite3 ^11\.7\.0
- 首次发布：2026-01-07T12:59:10.946Z
- 最新版本发布：2026-11-09T01:04:55.756Z
- 近 30 天下载量：5314（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：165（近 12 个月 165 个）

## 中文简介

将高级语言模型直接带入终端的 AI 动力开发助理

## 安装

```sh
npm install @compass-ai/nova
```

也可以使用：`pnpm add @compass-ai/nova`、`yarn add @compass-ai/nova`、`bun add @compass-ai/nova`

## README

# 诺瓦

**描述目标。 造出真实之事.**

**Compass 的AI代理,用于构建软件,解决问题,并将工作转化为结果,你可以审查.**

[![npm version](https://img.shields.io/npm/v/@compass-ai/nova.svg)](https://www.npmjs.com/package/@compass-ai/nova) [![Node.js](https://img.shields.io/badge/node-%3E%3D22.13.0-brightgreen)](https://nodejs.org/) [![License](https://img.shields.io/badge/license-Proprietary-blue)](https://npmcn.com/package/%40compass-ai/nova/LICENSE)

[开始吧](https://npmcn.com/package/%40compass-ai/nova/#readme-get-started) • 妇女 [为什么Nova](https://npmcn.com/package/%40compass-ai/nova/#readme-why-nova) • 妇女 [工作流量](https://npmcn.com/package/%40compass-ai/nova/#readme-put-nova-to-work) • 妇女 [文档](https://npmcn.com/package/%40compass-ai/nova/docs/README.md) • 妇女 [指南针](https://www.compassap.ai/)

* * *

一个想法。 一个破碎的特征。 一个不熟悉的项目。 一个最后期限。 从你需要的开始 用你自己的话来说.

Nova在终端里与你并肩工作——你的电脑上的命令行应用. 它读取您的工程,调查问题,编辑文件,运行命令,用测试检查它的工作. 对于更大的工作,它可以制定计划供批准,并引进专家助手。 除了软件外,它还通过现有的技能和整合,协助开展研究、介绍和电子表格.

**你决定了方向。 Nova负责台阶. 你看看结果.**

你不需要知道每一个命令 给Nova一个有用的任务。 您确实需要检讨重要的改变:AI可以犯错误,通过测试并不能保证.

> **专有软件,为真工所建.** 这个 [许可证](https://npmcn.com/package/%40compass-ai/nova/LICENSE) 允许个人使用和内部商业使用官方分销,包括商业开发。 它不声称拥有您的投入、项目或产出。 托管服务和模式访问可能需要单独的订阅或证书.

## 开始吧

安装方式 **节点js 22.13.0或更新** 财务报告和审定财务报表 **无**. 官方平台包覆盖了Windows x64,macOS arm64/x64,和Linux arm64/x64.

```powershell
npm install -g @compass-ai/nova
nova setup
nova
```

在窗口上, 退出 **所有新会话** 更新前。 运行 `npm install -g @compass-ai/nova` 在外部终端中,然后验证 `nova --version` 在重新开放Nova之前 持有本地文件打开的其他进程仍可导致 npm `EPERM` 清除警告; Nova 不抑制 npm 输出 .

Windows会话链接在第一次互动启动时设置一次,而不是安装期间. 如果设置失败, 请重试 `nova register-url-handler`;其他处理器从未被替换.

运行 `nova` 从您想要工作的仓库。 设置通过认证、提供者访问、同意和本地偏好为您提供指导。 这个 `compass` 命令作为别名仍然可用.

尝试第一个任务 :

```text
Explain how this project starts, identify its main components, and show me
which tests cover its most important behaviour. Do not change any files.
```

喜欢说话吗? Nova在互动会话中支持语音拼写. 寄出前先看笔录.

**语音拼写:设置、快捷方式和隐私**

### 指定一个快速( 交互式终端)

安装麦克风录音机 `PATH` 在启用语音前 : `winget install ffmpeg` 在窗口上, `brew install ffmpeg` 在macOS上,或您的发行量 `ffmpeg` linux 上的软件包。 Linux 也可以使用 `pw-record` 或者说 `arecord` 当可用时。 安装后重新启动终端( 如果已安装) `PATH` 未更新。 然后登录到指南针并运行 `/voice on` 在诺瓦. `/voice status` 显示活动记录器; `/voice off` 禁用此会话的拼写 .

第一个用途要求您承认音频被发送到 Compass , 用于使用您组织配置的密钥的 OpenAI Whisper 校对 。 Nova在抓取后删除临时的本地 WAV, 绝不自动提交生成的文本, 并记住您在用户- 全球配置中的确认( 而非打开/ 关闭设定) 。 您的组织必须配置 OpenAI 密钥 。 语音输入在打印模式,管会话,SDK/ACP,守护进程,以及AG-UI客户端中都是不可用的.

磁带 **缩写+ 空间** 或者说 **备选+V** 以开始录制;再次点击以停止并插入光标上的记录. **英格兰** 取消录音。 如果代理转弯正在进行中,则记录会排队,直到提示准备好; Esc 丢弃已排队的文本. 检查草稿,按你自己输入。 一些终端截取Ctrl+Space;取而代之的是Alt+V(macOS终端/iTerm2可能需要作为Meta选项). 单位 `config.json`, (中文(简体) ), `voice.keybindings` 可以选择其中之一或两者兼具。 沉默或非常短的片段被丢弃而不上传. 120秒后录音停止;转录不直播.

Dictation使用会话的响应语言,或者在第一次实质性请求之前使用英语. 用另一种语言来支配,使用 `/voice language pt-PT`· ; `/voice language default` 恢复会话语言. `voice.windowsDevice`, (中文(简体) ), `voice.linuxInput`,以及 `voice.silenceThresholdDb` 是用户-全球记录器/静态偏好。 v1没有下载记录器.

## 为什么Nova

| 你需要的东西 | Nova的帮助 |
| --- | --- |
| **工作成果,而不是另一项建议** | 调查、修改和进行项目测试和检查——然后报告所发生的变化和仍未核实的情况. |
| **行动前理解** | 读取已存在的代码和指示,遵循依附关系,并指明其发现背后的证据. |
| **帮个忙** | 建立审批专项规划,将重点任务下放给专家代理. |
| **少点重复时间** | 复述对话,并使用已保存的项目内存来将有用的上下文推进. |
| **实验室** | 将更改分离成一个孤立的 Git 工作空间, 这样您就可以在合并前对其进行审查 . |
| **AI模式的选择** | 支持 Compass 管理的存取,直接提供者,以及相容的自定义端点. |
| **对工作的明确看法** | 显示运行时间活动、使用和费用估计数,并配有当地仪表板进行更仔细的检查. |
| **超过代码** | 帮助将调查结果转化为演示或格式化的工作手册,并与其他工具和服务相连接. |

### 从调查到核查的一个工作流程

**了解/计划需要时执行/核查/审查**

Nova可以追踪相关代码,将复杂的修改转化为批准权计划,进行范围化编辑,并运行相关的检查. 专家特工可以另行提供核查证. 你审查证据并决定何时实施或公布.

简单的申请不需要规划仪式. 复杂的请求不需要在半途而废.

## 让Nova工作

从结果开始 加上你身上的束缚 连接服务和专家工作流程需要相关工具和账户访问.

| 你的目标 | 问Nova |
| --- | --- |
| **修正回归** | “找出在最近的认证变更后退出的原因。 重述,修复原因,并进行相关的测试。” |
| **播放专题** | “使用现有许可模式添加CSV导出。 首先检查当前流动情况并核实变化。” |
| **安全迁徙** | “规划数据库迁移,查明兼容性风险,等待批准后再实施。” |
| **获得第二次审查** | “使用一个核查代理审查这种回归和安全问题,而不编辑文件。” |
| **理解一个代码库** | “解释该项目的工作及其主要部分如何结合在一起。 不更改任何文件。” |
| **传达结果** | “从这些说明中创建一个PowerPoint发布简报,介绍用户的影响、风险和推出情况。” |
| **分析工作手册** | “检查该电子表格,解释异常情况,并编制一份格式化的简要工作手册。” |

### 捡起你离开的地方

```powershell
nova --continue
```

使用 `nova session` 浏览存档会话。 在谈话中, `/context` 显示上下文使用和 `/compact` 在长期工作期间帮助恢复空间.

**在单独的工作空间隔离更改**

### 隔离更改

```powershell
nova --worktree
```

开始于管理中的 Git 工作树和使用 `nova worktrees` 检查或管理它。 合并或抛弃孤立的工作是单独的动作,而不是启动会话的副作用.

为了编译和尝试那条工作树上的Nova CLI,打开一个单独的PowerShell终端并运行:

```powershell
Set-Location -LiteralPath '<worktree path shown by nova worktrees>'
npm ci
npm run build
npm start
```

`npm start` 运行工作树的编译 `dist/cli.js`,没有安装 `nova` 命令。 在编辑源文件后, 停止运行的 CLI, 用 `npm run build`,然后重新开始 `npm start`。该建筑写给 `dist` 在工作树上, 离开原始的退房建筑独自一人.

**会议之间的自动化、脚本和协调**

### 在脚本中使用 Nova

```powershell
nova --print "Summarise the staged diff. Do not modify files or create a commit."
nova --model gpt-5.6-luna --print "Inspect this workspace and suggest the next step."
```

打印模式运行一个单一的非交互查询,只写完成的最终答案到stdout. SDK 流回调和所积累的遗产 `content` 嵌入客户仍可获得结果; `finalText` 包含已完成的答案。 运行失败不打印部分答案 .

对于自成一体的写作任务,选择一个单一的文本补全. 在提示中提供完整的源材料;此路径不会读取寄存器,加载对话历史,或曝光工具. 需要一个具体的模型.

```powershell
nova --completion --model gpt-5.6-luna --system 'Return only a conventional commit message.' --max-tokens 120 --print 'Describe this supplied diff: ...'
```

嵌入客户端可以打电话 `runSDKCompletion({ prompt, model, system, maxTokens, abortSignal })`。结果包含 `text`、象征性使用、成本、停止理由和准备/提供/总时间。 CLI 仅写完成的文本来 stdout. `--completion` 拒绝会话、代理、附件和工具选项; `--system` 财务报告和审定财务报表 `--max-tokens` 仅适用于补全模式. 现有的 SDK 主机可能通过 `--unleash`;完成模式接受兼容性,而忽略它,因为这个路径没有工具或批准流.

`--model <model>` 选择用于打印引用的模型 ID 或别名,同时保留 Nova 的正常系统提示 。 它在不改变已保存的默认情况下, 覆盖代理和复会模式偏好 。 后端路由和故障失效仍然适用; 3; `--model auto` 请求自动路由.

```powershell
nova --print 'Return only JSON describing this project. Do not modify files.' --validate-json --progress
```

`--validate-json` 在释放 stdout 之前验证整个最终答案; 无效或空的 JSON 以非零退出和 stderr 诊断失败 。 它不强迫模型生成JSON,去除Markdown栅栏,或验证一个计划. `--progress` 在 stderr 中添加标签状态更新 . `--reasoning-summary` 在 Stderr (目前为 OpenAI Response) 中只添加有明确提供者支持的公开摘要; 无法获取的摘要不会产生产出, 原始思维永远不会被替换 。 工具诊断默认无声; `--tool-output compact` 或者说 `--tool-output verbose` 让他们在板上。 打印输出也会去掉标有的提供者推理前缀 `<think>`, (中文(简体) ), `<thinking>`,或 `<reasoning>`,包括当关闭标记识别前缀时缺失的打开标记.

对于融合客户, `nova tools-rpc` 曝光内部的 JSON- RPC stdio 工具服务器; 使用 `nova tools-rpc --help` 用于其明确的允许列表选项。 互动计划-生命周期工具没有打印模式.

### 让会议互相交谈

在交互式终端中使用 `/tag backend` 来命名一个对等会话,然后询问另一个会话: `Ask @backend about progress`类型 `@` 以选择活端; 完整的 ID 、 独有的 8 字符 ID 前缀, 并引用诸如 `@"Backend API"` 还有工作 解决的提及开启了本届会议的对等消息,直到 `/peers refuse` 或离开。 未知或模棱两可的提法显示错误. `@` 不再自动完成或隐含文件;取而代之的是使用普通路径或明确附件.

## 你的模型,你的整合

使用 Compass 管理的访问或配置一个支持的直接提供者 。 注册自定义终点 `nova models register`; 支持的电线计划包括 **安东尼**, (中文(简体) ), **OpenAI 聊天**,以及 **OpenAI 响应**。模型可用性、使用限制、账单和特性支持取决于您的提供者和账户.

通过已记录的接口扩展工作流程,而不修改 Nova 的执行 :

-   **技能:** 已建成的PowerPoint,电子表格,前端设计,以及技能发现工作流程. 额外技能可以安装到您的工作.
-   **磁共振:** 通过连接已配置的外部工具和资源服务器 `nova mcp`。 。 。 .
-   **福尔吉:** 创建可重复使用的项目工具,验证一个兄弟测试,并在通过MCP加载前予以批准. 附有联署材料 npm 分布的被蒙蔽的船只;见 [Forge 创建、安装和使用指南](https://npmcn.com/package/%40compass-ai/nova/docs/guides/forge-tools.md),包括明确的用户-全球副本和撤销.
-   **自定义命令和钩子 :** 包可重复的提示和项目特定生命周期的行为.
-   **计划任务 :** 通过活动的互动调度器或配置守护进程运行重复的工作流程 。 见 [时间安排行为和要求](https://npmcn.com/package/%40compass-ai/nova/docs/reference/tools/schedule-tools.md)。 。 。 .

**创建可重复使用的命令**

### 让工作流程可重复

创建 `.nova/commands/review.md` 在您的项目中使用 `.compass/commands/review.md` 相反, 如果遗留目录活动 :

```markdown
---
description: Review the current diff
---

Review the current diff for correctness, regressions, and missing tests.
Read the surrounding code. Report actionable findings with file references.
Do not modify files, stage changes, or create a commit.
```

然后运行 `/review` 在诺瓦 个人命令属于活动 `~/.nova/commands` 或者说 `~/.compass/commands` 目录.

**打开现场仪表板**

### 不离开工作流程的可见度

在开始会话前启用活事件 。 单位 **动力壳**数字 :

```powershell
$env:NOVA_OBSERVABILITY = "1"
nova
```

在另一个终端,来自同一项目:

```powershell
nova dashboard
```

Nova打开本地直播仪表板并打印其地址,连续性-视图地址,以及事件文件位置. 使用 `nova doctor` 用于诊断性健康检查;修理是分开的、经确认的行动.

**每日命令参考**

| 命令 | 目的 |
| --- | --- |
| `nova setup` 编号 : `nova init` | 配置访问和首选项/ 初始项目配置 . |
| `nova session` 编号 : `nova --continue` | 浏览存档会话 / 恢复最近的对话 . |
| `nova models` 编号 : `nova openai` | 管理自定义模型 / OpenAI 认证和使用流程 . |
| `nova mcp` 编号 : `nova lsp` | 管理MCP连接/本地JS/TS代码智能. |
| `nova worktrees` | 检查和管理新创造的工作树. |
| `nova commit` | 产生并创建一个常规承诺 从分阶段的变化. |
| `nova doctor` 编号 : `nova dashboard` | 诊断配置 / 开放本地直播可观察性. |
| `nova tokens` 编号 : `nova logs` | 检查令牌用途 / 系统事件日志 . |
| `nova data` 编号 : `nova consent` | 管理本地数据导出和删除/同意设置 . |
| `nova update` | 检查并安装更新 . |
| `nova --help` | 发现 CLI 命令和选项 . |

在会场内: `/help`, (中文(简体) ), `/model`, (中文(简体) ), `/plan`, (中文(简体) ), `/agents`, (中文(简体) ), `/mcp`, (中文(简体) ), `/context`, (中文(简体) ), `/compact`, (中文(简体) ), `/tokens`, (中文(简体) ), `/usage`, (中文(简体) ), `/ask`, (中文(简体) ), `/export`,以及 `/exit`。 。 。 .

新负载项目指令 `AGENTS.md`后退为 `NOVA.md` 何时 `AGENTS.md` 缺席。 相同的选择独立地适用于活动项目和全球状态目录( Q)`.nova` 遗产 `.compass`) (中文(简体) ). 如果两个文件都存在于一个位置,则仅 `AGENTS.md` 已装入, 即使为空; 合并或删除 `NOVA.md` 这取决于你。 个人 `NOVA.local.md` 和 国家指南 `rules/*.md` 继续装入 。 自动发现覆盖了这些位置,而不是嵌入子目录.

## 控制、隐私和负责任的使用

诺瓦在当地运行,但 **本地执行并不意味着所有数据都留在您的机器上**: 提示, 选定的代码上下文, 和工具内容可以发送到您所配置的模型提供者或连接的服务. 选择适合您数据的整合和同意设置 .

-   **政策性行动:** 工具执行须遵守运行时间政策,审批,并有钩子. 批准行为取决于您配置的模式; 启用自动化前的审查权限 .
-   **需要分离的地方:** 管理工作树和支持的文件编辑备份有助于维护和恢复工作。 在运输前审查diffs和核查结果.
-   **在您控制下的连续性 :** 本地配置,记忆,和会话状态使用Nova的活跃状态目录. 数据出口、删除和同意管制可通过《国家清单》提供.
-   **防御性安全重点:** Nova的默认安全指示支持防御分析和补救,而不是恶意活动或证书收割.

新设施使用情况 `.nova`; 已有 `.compass` 仍然支持目录。 升级不会自动重命名或合并它们. 见 [状态目录相容性和人工迁移](https://npmcn.com/package/%40compass-ai/nova/docs/guides/nova-state-directory-migration.md)。 。 。 .

## 帮助和文件

开始 `nova doctor` 对于设置问题, `nova setup` 重新配置访问,以及 `/help` 用于会期指导。 使用 `nova --debug` 在对问题进行调查时,在共享敏感内容之前审查日志。 要删除 npm 软件包, 请运行 `npm uninstall -g @compass-ai/nova`;分别审查当地州保留.

[文件索引](https://npmcn.com/package/%40compass-ai/nova/docs/README.md) • 妇女 [内置工具参考](https://npmcn.com/package/%40compass-ai/nova/docs/reference/tools/README.md) • 妇女 [仓库指导](https://npmcn.com/package/%40compass-ai/nova/NOVA.md) • 妇女 [npm 软件包](https://www.npmjs.com/package/@compass-ai/nova) • 妇女 [指南针](https://www.compassap.ai/)

## 许可证

**Nova是专有软件,不是开源软件.** 你可以安装和使用官方发布 个人使用和您的组织的内部业务使用,包括商业开发.

这个 [Nova 专有软件许可证](https://npmcn.com/package/%40compass-ai/nova/LICENSE) 载有具有约束力的条款,并优先于本摘要:

-   **你可以这样:** 安装并使用正式的Nova发布给您本人或在您公司内部,包括有偿客户工作. 保存任何副本 安装或备份完好, 与他们的法律通知。 您可以以 Nova 文档描述的方式配置、 扩展和连接 .
-   **你不能这样:** 分享或出售Nova, 把它租出去, 改变它, 建立你自己的产品, 复制它的代码, 把它拆开看看它是如何工作的, 绕过它的保护, 运行它作为服务给别人, 或者删除它的版权通知—— 除非 Compass 书面同意 或者法律赋予你这种权利.
-   **你的工作是: 你的工作是: 你的工作是:** 该许可证不声称拥有您的投入、项目或产出,或限制其使用,仅仅因为您使用了Nova。 它不保证第三方材料的所有权或清关;其他人的权利和适用的服务条款仍然适用.
-   **未包括的内容:** 付费或托管服务(如模式访问)需要自己的订阅。 Nova的第三方部分保留自己的执照,你已经拥有的旧版发行权不受影响. 如果你和康帕斯有单独签署的协议,在两者不同的地方就胜出.

需要更多吗? 联系人 [指南针](https://www.compassap.ai/)。 。 。 .

* * *

日期:2026-06-24-最后修改:2026-10-20

共同撰写人: [诺瓦](https://www.compassap.ai/portfolio/nova.html)

## 常见问题

### @compass-ai/nova 是什么？

将高级语言模型直接带入终端的 AI 动力开发助理

### 如何安装 @compass-ai/nova？

在项目目录运行 npm install @compass-ai/nova，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 nova、compass，可以用 npx nova 直接运行。

### @compass-ai/nova 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/compass-ai\_\_nova 是否存在。

### @compass-ai/nova 支持 ESM 还是 CommonJS？

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

### @compass-ai/nova 需要什么版本的 Node\.js？

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

### @compass-ai/nova 可以商用吗？

@compass-ai/nova 使用 SEE LICENSE IN LICENSE 许可。许可条款写在包内的独立文件中，请阅读该文件确认可否商用。以上为概括，不构成法律意见，请以许可原文为准。

### @compass-ai/nova 的下载量有多少？

根据 npm 官方下载统计，@compass-ai/nova 在 2026/10/11 – 2026/11/09 这 30 天内被下载 5,314 次，日均约 177 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @compass-ai/nova 还在维护吗？

最新版本 1\.1\.65 发布于 2026/11/09（1 天前）；至今共发布 165 个版本，其中过去 12 个月发布了 165 个；首次发布于 2026/01/07。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。