@compass-ai/nova

中文文档
1.1.65发布于 2026/11/09SEE LICENSE IN LICENSEES Module近 30 天下载 5314

AI-powered development assistant that brings advanced language models directly to your terminal

原始使用文档
文档目录15 节
  1. Get started
  2. Dictate a prompt (interactive terminal)
  3. Why Nova
  4. One workflow, from investigation to verification
  5. Put Nova to work
  6. Pick up where you left off
  7. Isolate a change
  8. Use Nova in scripts
  9. Let sessions talk to each other
  10. Your models, your integrations
  11. Make a workflow repeatable
  12. Visibility without leaving your workflow
  13. Control, privacy, and responsible use
  14. Help and documentation
  15. Licence

Nova

Describe the goal. Build something real.

The AI agent by Compass for building software, solving problems, and turning work into results you can review.

npm version Node.js License

Get started · Why Nova · Workflows · Documentation · Compass


An idea. A broken feature. An unfamiliar project. A deadline. Start with what you need, in your own words.

Nova works alongside you in the terminal — the command-line app on your computer. It reads your project, investigates problems, edits files, runs commands, and checks its work with tests. For larger jobs, it can prepare a plan for approval and bring in specialist helper agents. Beyond software, it helps with research, presentations, and spreadsheets through available skills and integrations.

You set the direction. Nova handles the steps. You review the result.

You do not need to know every command to give Nova a useful task. You do need to review important changes: AI can make mistakes, and passing tests are not a guarantee.

Proprietary software, built for real work. The licence permits personal use and internal business use of official distributions, including commercial development. It does not claim ownership of your inputs, projects, or generated outputs. Hosted services and model access may require separate subscriptions or credentials.

Get started

Install with Node.js 22.13.0 or newer and npm. Official platform packages cover Windows x64, macOS arm64/x64, and Linux arm64/x64.

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

On Windows, exit all Nova sessions before updating. Run npm install -g @compass-ai/nova in an external terminal, then verify nova --version before reopening Nova. Other processes holding native files open can still cause npm EPERM cleanup warnings; Nova does not suppress npm output.

Windows session links are set up once on the first interactive launch, not during installation. If setup fails, retry with nova register-url-handler; other handlers are never replaced.

Run nova from the repository you want to work on. Setup guides you through authentication, provider access, consent, and local preferences. The compass command remains available as an alias.

Try a first task:

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

Prefer speaking? Nova supports voice dictation in interactive sessions. Review the transcript before sending it.

Voice dictation: setup, shortcuts, and privacy

Dictate a prompt (interactive terminal)

Install a microphone recorder on PATH before enabling voice: winget install ffmpeg on Windows, brew install ffmpeg on macOS, or your distribution's ffmpeg package on Linux. Linux can also use pw-record or arecord when available. Restart the terminal after installation if its PATH has not updated. Then log in to Compass and run /voice on inside Nova. /voice status shows the active recorder; /voice off disables dictation for this session.

The first use asks you to acknowledge that audio is sent to Compass for OpenAI Whisper transcription using your organisation's configured key. Nova deletes the temporary local WAV after capture, never submits the resulting text automatically, and remembers your acknowledgement (not the on/off setting) in user-global configuration. Your organisation must have an OpenAI key configured. Voice input is unavailable in print mode, piped sessions, SDK/ACP, daemon, and AG-UI clients.

Tap Ctrl+Space or Alt+V to start recording; tap again to stop and insert the transcript at the cursor. Esc cancels a recording. If an agent turn is in progress, the transcript is queued until the prompt is ready; Esc discards queued text. Review the draft and press Enter yourself. Some terminals intercept Ctrl+Space; use Alt+V instead (macOS Terminal/iTerm2 may require Option as Meta). In config.json, voice.keybindings can choose either or both bindings. Silent or very short clips are discarded without upload. Recording stops after 120 seconds; transcription is not live.

Dictation uses the session's response language, or English before the first substantive request. To dictate in a different language, use /voice language pt-PT; /voice language default restores the session language. voice.windowsDevice, voice.linuxInput, and voice.silenceThresholdDb are optional user-global recorder/silence preferences. No recorder is downloaded by v1.

Why Nova

What you needHow Nova helps
A working result, not another suggestionInvestigates, makes changes, and runs your project's tests and checks — then reports what changed and what remains unverified.
Understanding before actionReads existing code and instructions, follows dependencies, and points to the evidence behind its findings.
Help with a bigger jobCreates approval-gated plans and delegates focused tasks to specialist agents.
Less time repeating yourselfResumes conversations and uses saved project memory to carry useful context forward.
Room to experimentSeparates changes into an isolated Git workspace so you can review them before merging.
A choice of AI modelsSupports Compass-managed access, direct providers, and compatible custom endpoints.
A clear view of the workShows runtime activity, usage and cost estimates, with a local dashboard for closer inspection.
More than codeHelps turn findings into a presentation or formatted workbook, and connects to additional tools and services.

One workflow, from investigation to verification

Understand → Plan when needed → Implement → Verify → Review

Nova can trace the relevant code, turn complex changes into approval-gated plans, make scoped edits, and run the checks that matter. Specialist agents can provide a separate verification pass. You review the evidence and decide when to commit or publish.

Simple requests do not need a planning ceremony. Complex requests do not need to lose their context halfway through.

Put Nova to work

Start with an outcome. Add the constraints that matter to you. Connected services and specialist workflows require the relevant tools and account access.

Your goalAsk Nova
Fix a regression“Find why checkout fails after the latest auth change. Reproduce it, fix the cause, and run the relevant tests.”
Deliver a feature“Add CSV export using the existing permissions model. Inspect the current flow first and verify the change.”
Make a safe migration“Plan the database migration, identify compatibility risks, and wait for approval before implementing.”
Get a second review“Use a verification agent to review this diff for regressions and security issues without editing files.”
Understand a codebase“Explain what this project does and how its main parts fit together. Do not change any files.”
Communicate the result“Create a PowerPoint release briefing from these notes, covering user impact, risks, and rollout.”
Analyse a workbook“Inspect this spreadsheet, explain the anomalies, and produce a formatted summary workbook.”

Pick up where you left off

nova --continue

Use nova session to browse archived sessions. In a conversation, /context shows context usage and /compact helps recover space during long-running work.

Isolate changes in a separate workspace

Isolate a change

nova --worktree

Start in a managed Git worktree and use nova worktrees to inspect or manage it. Merging or discarding isolated work is a separate action, not a side effect of starting a session.

To compile and try the Nova CLI from that worktree, open a separate PowerShell terminal and run:

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

npm start runs that worktree's compiled dist/cli.js, not an installed nova command. After editing source files, stop the running CLI, rebuild with npm run build, and start it again with npm start. The build writes to dist in the worktree, leaving the original checkout's build alone.

Automation, scripting, and coordination between sessions

Use Nova in scripts

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."

Print mode runs a single non-interactive query and writes only the completed final answer to stdout. SDK streaming callbacks and the legacy accumulated content result remain available to embedded clients; finalText contains the completed answer. Failed runs do not print partial answers.

For a self-contained writing task, opt into a single text completion. Supply the full source material in the prompt; this path does not read the repository, load conversation history, or expose tools. A concrete model is required.

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

Embedded clients can call runSDKCompletion({ prompt, model, system, maxTokens, abortSignal }). The result contains text, token usage, cost, stop reason, and preparation/provider/total timings. The CLI writes only the completed text to stdout. --completion rejects session, agent, attachment, and tool options; --system and --max-tokens apply only to completion mode. Existing SDK hosts may pass --unleash; completion mode accepts it for compatibility and ignores it because this path has no tools or approval flow.

--model <model> selects a model ID or alias for the print invocation while retaining Nova's normal system prompt. It overrides agent and resumed-session model preferences without changing the saved default. Backend routing and failover still apply; --model auto requests automatic routing.

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

--validate-json validates the entire final answer before emitting stdout; invalid or empty JSON fails with a nonzero exit and a stderr diagnostic. It does not force the model to generate JSON, remove Markdown fences, or validate a schema. --progress adds labelled status updates to stderr. --reasoning-summary adds only explicit provider-supported public summaries to stderr (currently OpenAI Responses); unavailable summaries produce no output, and raw thinking is never substituted. Tool diagnostics are silent by default; --tool-output compact or --tool-output verbose enables them on stderr. Print output also removes provider reasoning prefixes marked with <think>, <thinking>, or <reasoning>, including a missing opening tag when a closing tag identifies the prefix.

For integration clients, nova tools-rpc exposes an internal JSON-RPC stdio tool server; use nova tools-rpc --help for its explicit tool allowlist options. Interactive plan-lifecycle tools are not available in print mode.

Let sessions talk to each other

In interactive terminals, use /tag backend to name a peer session, then ask another session: Ask @backend about progress. Type @ to select a live peer; full IDs, unique eight-character ID prefixes, and quoted names such as @"Backend API" also work. A resolved mention turns on peer messaging for the current session until /peers refuse or exit. Unknown or ambiguous mentions show an error. @ no longer autocompletes or implicitly includes files; use ordinary paths or explicit attachments instead.

Your models, your integrations

Use Compass-managed access or configure a supported direct provider. Register custom endpoints with nova models register; supported wire schemas include Anthropic, OpenAI Chat, and OpenAI Responses. Model availability, usage limits, billing, and feature support depend on your provider and account.

Extend the workflow through documented interfaces, without modifying Nova's implementation:

  • Skills: Built-in PowerPoint, spreadsheet, frontend-design, and skill-discovery workflows. Additional skills can be installed for your work.
  • MCP: Connect configured servers for external tools and resources through nova mcp.
  • Forge: Create reusable project tools, validate a sibling test, and approve them before loading through MCP. Forge ships with supported obfuscated JS npm distributions; see the Forge creation, installation, and usage guide, including explicit user-global copies and revocation.
  • Custom commands and hooks: Package repeatable prompts and project-specific lifecycle behaviour.
  • Scheduled tasks: Run recurring workflows through an active interactive scheduler or configured daemon. See scheduling behaviour and requirements.
Create a reusable command

Make a workflow repeatable

Create .nova/commands/review.md in your project, using .compass/commands/review.md instead if that legacy directory is active:

---
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.

Then run /review inside Nova. Personal commands belong in the active ~/.nova/commands or ~/.compass/commands directory.

Open the live dashboard

Visibility without leaving your workflow

Enable live events before starting a session. In PowerShell:

$env:NOVA_OBSERVABILITY = "1"
nova

In another terminal, from the same project:

nova dashboard

Nova opens the local live dashboard and prints its address, continuity-view address, and event-file location. Use nova doctor for diagnostic health checks; repairs are separate, confirmation-gated actions.

Everyday command reference
CommandPurpose
nova setup / nova initConfigure access and preferences / initialise project configuration.
nova session / nova --continueBrowse archived sessions / resume the most recent conversation.
nova models / nova openaiManage custom models / OpenAI authentication and usage flows.
nova mcp / nova lspManage MCP connections / local JS/TS code intelligence.
nova worktreesInspect and manage Nova-created worktrees.
nova commitGenerate and create a conventional commit from staged changes.
nova doctor / nova dashboardDiagnose configuration / open local live observability.
nova tokens / nova logsInspect token usage / system event logs.
nova data / nova consentManage local data export and deletion / consent settings.
nova updateCheck for and install updates.
nova --helpDiscover CLI commands and options.

Inside a session: /help, /model, /plan, /agents, /mcp, /context, /compact, /tokens, /usage, /ask, /export, and /exit.

Nova loads project instructions from AGENTS.md, falling back to NOVA.md when AGENTS.md is absent. The same selection applies independently in the active project and global state directories (.nova or legacy .compass). If both files exist in one location, only AGENTS.md is loaded, even if empty; merging or deleting NOVA.md is up to you. Personal NOVA.local.md and state-directory rules/*.md continue to load as before. Automatic discovery covers these locations, not nested subdirectories.

Control, privacy, and responsible use

Nova runs locally, but local execution does not mean all data stays on your machine: prompts, selected code context, and tool content may be sent to your configured model providers or connected services. Choose integrations and consent settings appropriate to your data.

  • Policy-governed actions: Tool execution is subject to runtime policy, approvals, and hooks. Approval behaviour depends on your configured mode; review permissions before enabling automation.
  • Separation where it matters: Managed worktrees and supported file-edit backups help preserve and recover work. Review diffs and verification results before shipping.
  • Continuity under your control: Local configuration, memories, and session state use Nova's active state directories. Data export, deletion, and consent controls are available through the CLI.
  • Defensive security focus: Nova's default security instructions support defensive analysis and remediation, not malicious activity or credential harvesting.

New installations use .nova; existing .compass directories remain supported. Upgrading does not automatically rename or merge them. See state-directory compatibility and manual migration.

Help and documentation

Start with nova doctor for setup problems, nova setup to reconfigure access, and /help for in-session guidance. Use nova --debug when investigating a problem, and review logs for sensitive content before sharing them. To remove the npm package, run npm uninstall -g @compass-ai/nova; review local-state retention separately.

Documentation index · Built-in tool reference · Repository guidance · npm package · Compass

Licence

Nova is proprietary software, not open source. You may install and use official releases for personal use and your organisation's internal business use, including commercial development.

The Nova Proprietary Software Licence contains the binding terms and takes precedence over this summary:

  • You can: install and use official Nova releases for yourself or inside your company, including on paid client work. Keep any copies you make for installation or backup intact, with their legal notices. You can configure, extend, and connect Nova in the ways its documentation describes.
  • You can't: share or sell Nova, rent it out, change it, build your own product from it, copy its code, take it apart to see how it works, get around its protection, run it as a service for others, or remove its copyright notices — unless Compass agrees in writing or the law gives you that right.
  • Your work: this licence does not claim ownership of your inputs, projects, or generated outputs, or restrict their use merely because you used Nova. It does not guarantee ownership or clearance of third-party material; other people's rights and applicable service terms still apply.
  • What's not included: paid or hosted services (such as model access) need their own subscription. Third-party parts of Nova keep their own licences, and rights you already have for older releases are unaffected. If you have a separate signed agreement with Compass, it wins where the two differ.

Need more than this allows? Contact Compass.


Date: 2026-06-24 · Last modified: 2026-10-20

Co-authored by Nova

版本与发布记录

@compass-ai/nova 共发布 165 个版本,首次发布于 2026/01/07;过去 12 个月发布了 165 个版本。

版本发布日期距今
1.1.65latest2026/11/091 天前
1.1.642026/11/064 天前
1.1.632026/11/045 天前
1.1.622026/10/3011 天前
1.1.602026/10/2714 天前
1.1.592026/10/2021 天前

关于 @compass-ai/nova 的常见问题

@compass-ai/nova 是什么?

AI-powered development assistant that brings advanced language models directly to your terminal

如何安装 @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 和提交记录判断。