Neovim Lua API Reference

Reference Neovim's Lua API functions, types, and namespaces for plugin development.

Updated Apr 26, 2026
One-click install
npx skills add https://github.com/farreeez/99 --skill neovim-lua-api-reference
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: Neovim Lua API Reference
Source: https://github.com/farreeez/99/tree/main/.agents/skills/vim
Command: npx skills add https://github.com/farreeez/99 --skill neovim-lua-api-reference

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill provides detailed type stubs and API references for Neovim's Lua scripting environment, enabling developers to write plugins and configurations more effectively.

Core Features & Use Cases

  • API Reference: Offers exhaustive lists of functions, types, and namespaces available in Neovim's Lua API.
  • Developer Support: Assists plugin developers and advanced users in understanding available APIs and their usage.
  • Use Case: A developer wants to find all functions for manipulating buffers and windows; consult this reference to integrate them into their Lua scripts.

Quick Start

Use this documentation to look up the vim.api.nvim_buf_get_lines function to retrieve lines from a buffer.

Frequently Asked Questions about Neovim Lua API Reference

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
What is the Neovim Lua API used for?

You can use the Neovim Lua API to manipulate buffers and windows by referencing core namespaces and functions, such as calling `vim.api.nvim_buf_get_lines` to retrieve specific lines from a buffer.

How do I get lines from a buffer using the Neovim Lua API?

You can use the Neovim Lua API to manipulate buffers and windows by referencing core namespaces and functions, such as calling `vim.api.nvim_buf_get_lines` to retrieve specific lines from a buffer.

Does Neovim Lua API documentation cover buffer and window functions?

Yes, the Neovim Lua API documentation includes specific focus on buffer, window, and internal API functions, ensuring efficient scripting and manipulation within your plugin development workflow.

What is the best way to find available functions for Neovim plugin development?

The best way to find available functions is consulting a structured Neovim Lua API reference, which offers exhaustive lists of functions, types, and namespaces for script automation and configuration.

Can I use the Neovim Lua API for editor scripting and configuration?

Yes, you can use the Neovim Lua API for editor scripting and configuration, as it provides detailed type stubs and references to facilitate writing plugins and setting up advanced configurations.