chat.nvim

A lightweight, extensible chat plugin for Neovim with AI integration. Chat with AI assistants directly in your editor using a clean, floating window interface.

<!-- vim-markdown-toc GFM -->

• ✨ Features
• 📦 Installation
  • Prerequisites
  • Package Manager Installation
    • Using nvim-plug
    • Using lazy.nvim
    • Using packer.nvim
  • Manual Installation
  • Post-Installation Setup
  • Quick Start
• 🔧 Configuration
  • Basic Options
  • HTTP Server Configuration
  • API Key Configuration
  • File Access Control
  • Context Window Configuration
  • Memory System Configuration
  • system_prompt Usage Examples
  • MCP Server Configuration
  • IM Integration Configuration
  • Complete Configuration Example
  • Configuration Notes
• ⚙️ Usage
  • Basic Commands
  • MCP Commands
  • Parallel Sessions
  • Examples
  • Key Bindings
• 🤖 Providers
  • Built-in Providers
  • Custom Providers
  • Protocols
• 🛠️ Tools
  • MCP Tools
  • Available Tools
    • read_file
    • write_file
    • find_files
    • search_text
    • extract_memory
    • recall_memory
    • set_prompt
    • fetch_web
    • web_search
    • git_add
    • git_commit
    • git_diff
    • git_log
    • git_status
    • git_show
    • get_history
    • plan
  • Third-party Tools
    • zettelkasten_create
    • zettelkasten_get
  • How to Use Tools
  • Custom Tools
    • Synchronous Tool Example
    • Asynchronous Tool Example
• 🌐 HTTP API
  • Enabling the HTTP Server
  • API Endpoints
  • Request Format
  • Response Format
    • POST /
    • GET /sessions
    • GET /session
  • Message Queue System
  • Usage Examples
    • Using curl:
    • Using Python:
  • Security Considerations
  • Integration Ideas
• 🔍 Picker Integration
• 💬 IM Integration
  • Supported Platforms
  • Discord
    • Features
    • Setup Guide
    • Commands
    • Workflow
    • Technical Details
    • Troubleshooting
  • Lark (Feishu)
    • Features
    • Setup Guide
    • Commands
    • Technical Details
  • DingTalk
    • Features
    • Setup Guide
    • Technical Details
  • WeCom (Enterprise WeChat)
    • Features
    • Setup Guide
    • Technical Details
  • Weixin (Personal WeChat)
    • Features
    • Setup Guide
    • Commands
    • Technical Details
  • Telegram
    • Features
    • Setup Guide
    • Commands
    • Workflow
    • Technical Details
    • Troubleshooting
  • Slack
    • Features
    • Setup Guide
    • Commands
    • Workflow
    • Technical Details
    • Troubleshooting
    • Notes
  • Common Features
  • Platform-Specific Notes
  • Contributing New Integrations
• 📣 Self-Promotion
• 💬 Feedback
• 📄 License

<!-- vim-markdown-toc -->

✨ Features

• Three-Tier Memory System: Working memory (session tasks), daily memory (short-term goals), and long-term memory (permanent knowledge) with automatic extraction and priority-based retrieval
• Parallel Sessions: Run multiple independent conversations with different AI models, each maintaining separate context and settings
• Multiple AI Providers: Built-in support for DeepSeek, GitHub AI, Moonshot, OpenRouter, Qwen, SiliconFlow, Tencent, BigModel, Volcengine, OpenAI, LongCat, Anthropic Claude, Google Gemini, Ollama, and custom providers
• Tool Call Integration: Built-in tools for file operations (@read_file, @find_files, @search_text), version control (@git_diff, @git_log, @git_status, @git_show), conversation history (@get_history), memory management...
• Zettelkasten Integration: Note-taking support via @zettelkasten_create and @zettelkasten_get tools for knowledge management (requires zettelkasten.nvim)
• IM Integration: Connect Discord, Lark (Feishu), DingTalk, WeCom (Enterprise WeChat), and Telegram channels to chat.nvim sessions for remote AI interaction
• HTTP API Server: Built-in HTTP server for receiving external messages with API key authentication and message queue support
• Session Management: Commands for creating (:Chat new), navigating (:Chat prev/next), clearing (:Chat clear), deleting (:Chat delete), saving (:Chat save), loading (:Chat load), sharing (:Chat share), bridging (:Chat bridge), previewing (:Chat preview), and changing working directory (:Chat cd)
• Picker Integration: Seamless integration with picker.nvim for browsing chat history (picker-chat), switching providers (chat_provider), and selecting models (chat_model)
• Floating Window Interface: Clean, non-intrusive dual-window layout with configurable dimensions and borders
• Streaming Responses: Real-time AI responses with cancellation support (Ctrl-C) and retry mechanism (r)
• Token Usage Tracking: Display real-time token consumption for each response
• Lightweight Implementation: Pure Lua with minimal dependencies and comprehensive error handling
• Customizable Configuration: Flexible setup for API keys, allowed paths, memory settings, and system prompts
• Session HTML Preview: Generate and open HTML previews of chat sessions in your browser via :Chat preview command or <C-o> in picker
• Custom Tools: Support for creating custom tools via lua/chat/tools/<tool_name>.lua with automatic discovery
• Custom Providers: Support for creating custom AI providers with custom protocols
• Custom Protocols: Support for custom API response parsing (OpenAI, Anthropic, Gemini, and extensible)
• Context Window Truncation: Automatic context management with configurable trigger threshold and recent message preservation to prevent token limit issues
• Token Usage Tracking: Display real-time token consumption including cached tokens for each response
• Customizable Highlights: Configure title text and badge highlight groups to match your colorscheme
• Title Icons: Visual session indicators with customizable icons for different session states
• MCP (Model Context Protocol) Support: Native integration with MCP servers for extended tool capabilities. Automatically discover and call MCP tools alongside built-in tools with seamless protocol handling and async execution

📦 Installation

Prerequisites

1. System Dependencies (optional but recommended for full functionality):

   • ripgrep (rg): Required for the @search_text tool
   • curl: Required for the @fetch_web tool
   • git: Required for the `@git_