noice.nvim API Reference

Reference noice.nvim Lua module functions and user commands.

1|Updated Oct 26, 2025
One-click install
npx skills add https://github.com/NeKon69/nvim-dot --skill noice-nvim-api-reference
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: noice.nvim API Reference
Source: https://github.com/NeKon69/nvim-dot/tree/main/.agents/skills/noice.nvim
Command: npx skills add https://github.com/NeKon69/nvim-dot --skill noice-nvim-api-reference

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides a quick reference for the noice.nvim plugin's API and commands, helping users quickly find and utilize its functionalities without deep diving into source code.

Core Features & Use Cases

  • API Indexing: Lists available Lua module functions for programmatic control.
  • Command Reference: Highlights user-facing commands for direct invocation.
  • Quick Notes: Identifies complex API calls that require careful handling.
  • Use Case: A developer needs to quickly find the correct noice function to display a custom notification and its parameters.

Quick Start

Use the noice skill to enable the noice plugin.

Frequently Asked Questions about noice.nvim API Reference

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

FAQPage Schema
How do I find the correct noice.nvim function to display a custom notification in Neovim?

To display a custom notification, this noice.nvim API reference lists available Lua module functions and their parameters for programmatic control. It facilitates quick lookups to integrate notification calls efficiently into Neovim configurations.

What user commands does the noice.nvim plugin provide for direct invocation?

The noice.nvim plugin provides a command reference highlighting user-facing commands for direct invocation. You can quickly find and utilize these commands to trigger plugin functionalities without deep diving into the source code.

How can I quickly look up noice.nvim module functions for my Lua configuration?

You can look up noice.nvim module functions using this API reference, which lists available Lua functions for programmatic control. It requires direct access to the plugin's runtime files to retrieve accurate information for your configuration.

Does the noice.nvim API reference require access to the plugin's source code?

Yes, the noice.nvim API reference requires direct access to the plugin's runtime files for accurate information retrieval. It prevents manual source code searches by indexing functions and commands for quick configuration integration.

Are there any complex noice.nvim API calls that require careful handling?

Yes, the noice.nvim reference includes quick notes identifying complex API calls requiring careful handling. This helps developers avoid integration errors when utilizing advanced plugin functionalities in their Neovim setup.