快速开始

准备好试用 Neovate Code 了吗？开始非常简单：

npm install -g @neovate/code
neovate

我们支持所有提供商的 API KEY 环境变量。如果你还没有 API Key，可以输入 /login，选择一个提供商，打开其官网并填写 API Key。

然后输入 /model 来选择该提供商的模型。

之后你就可以开始使用 Neovate Code 了，在命令行中描述你想做的事情，审查建议的更改，并批准工具调用。

# 你可以尝试的一些示例：
“为用户认证函数添加错误处理”
“将这个组件重构为使用 TypeScript”
“为支付服务创建单元测试”
“优化这条数据库查询”

请访问我们的 快速入门 文档，获取详细的安装和设置说明。

参与贡献

欢迎大家一起参与贡献！请阅读 CONTRIBUTING.md 文件，了解如何搭建开发环境、运行测试以及提交 Pull Request 的相关指南。

许可证

MIT

Neovate Code 快速上手指南

Neovate 是一款智能编码代理（Coding Agent），旨在增强您的开发工作流。它可以帮助您生成代码、修复漏洞、审查代码、编写测试等。

环境准备

• 操作系统：支持 macOS、Linux 和 Windows。
• 前置依赖：需预先安装 Node.js 及 npm 包管理器。
• API Key：使用前需准备支持的 LLM 提供商（如 OpenAI 等）的 API Key。

安装步骤

使用 npm 全局安装 Neovate Code：

npm install -g @neovate/code

💡 国内加速提示：若下载缓慢，可配置淘宝镜像源进行安装：

npm config set registry https://registry.npmmirror.com
npm install -g @neovate/code

基本使用

1. 启动与登录

在终端输入以下命令启动工具：

neovate

• 若未配置 API Key，请在交互界面输入 /login。
• 选择对应的服务提供商，按提示打开网页获取并填入 API Key。
• 输入 /model 选择该提供商下的具体模型。

2. 开始编码

配置完成后，直接在命令行描述您的需求，Neovate 将生成方案供您审查并批准执行。

使用示例：

"Add error handling to the user authentication function"
"Refactor this component to use TypeScript"
"Create unit tests for the payment service"
"Optimize this database query"

工具会提出具体的代码修改建议或调用相关工具，确认无误后批准即可自动完成操作。

更多详细文档请访问：Neovate 官方文档