Quick Start

Get started with Neovate Code in minutes.

Prerequisites

• Node.js 18+ 
• Terminal access
• A coding project

Installation

Install globally via npm:

npm i @neovate/code -g

Verify installation:

neovate --version

Initial Setup

Navigate to your project and start Neovate Code:

cd /path/to/your/project
neovate

On first run, you’ll be prompted to configure a provider:

1. Type /login and select your AI provider
2. Enter your API key

3. Type /model to choose a model

Start Coding

You’re now in interactive mode. Try these commands:

> explain this project
> create a testcase for @src/components/Button.tsx
> what is the purpose of this project
> analyze the dependencies of this project

Review & Commit

After making changes, stage them and get a review:

git add .
neovate /review

Generate and commit with AI assistance:

neovate commit

What’s next?

After you’ve completed the quickstart, you can learn more about the following topics:

• CLI
• Settings
• Rules
• Models