Getting Started

Table of contents

  1. Getting Started
    1. Overview
    2. Quick Links
    3. Prerequisites
    4. First Steps
      1. 1. Install the Plugin
      2. 2. Configure API Keys
      3. 3. Start Chatting
    5. Next Steps

Welcome to chat.nvim! This guide will help you get started with the plugin.

Overview

chat.nvim is a lightweight, extensible chat plugin for Neovim with AI integration. It allows you to:

  • Chat with AI assistants directly in your editor
  • Manage multiple parallel sessions with different models
  • Use built-in tools for file operations, Git, web search, etc.
  • Integrate with instant messaging platforms for remote access

Prerequisites

Before installing chat.nvim, ensure you have:

  1. Neovim 0.9+ - Required for modern Lua features
  2. job.nvim - Required dependency for async operations
  3. picker.nvim - Optional but recommended for enhanced UI
  4. System tools (optional): ripgrep, curl, git for full tool functionality

First Steps

1. Install the Plugin

Follow the Installation Guide for your package manager.

2. Configure API Keys

Set up API keys for your preferred AI providers:

require('chat').setup({
  api_key = {
    deepseek = 'sk-xxxxxxxxxxxx',
    openai = 'sk-xxxxxxxxxxxx',
  },
})

3. Start Chatting

Open the chat window and start your first conversation:

:Chat

Next Steps

After getting started, explore:

Table of contents