Octo.nvim API Reference

Reference Octo.nvim Lua functions and commands for GitHub interactions.

1|Updated Oct 26, 2025
One-click install
npx skills add https://github.com/NeKon69/nvim-dot --skill octo-nvim-api-reference
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: Octo.nvim API Reference
Source: https://github.com/NeKon69/nvim-dot/tree/main/.agents/skills/octo.nvim
Command: npx skills add https://github.com/NeKon69/nvim-dot --skill octo-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 Octo.nvim plugin's API and commands, allowing users to efficiently find and utilize its functionalities without deep diving into source code.

Core Features & Use Cases

  • API Indexing: Lists all available Lua functions within the octo module.
  • Command Reference: Highlights user-facing commands added by the plugin.
  • Quick Notes: Identifies potentially complex API calls that require careful consideration of arguments and state.
  • Use Case: A developer needs to quickly find the correct function to create a new Octo.nvim buffer for a specific repository and kind of object. They can consult this Skill to find require("octo").create_buffer(kind, obj, repo, create, hostname).

Quick Start

Use the octo.nvim skill to find the function for configuring an Octo.nvim buffer given a buffer number.

Frequently Asked Questions about Octo.nvim API Reference

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

FAQPage Schema
How do I find the correct Lua function to create an Octo.nvim buffer for a specific repository?

To create an Octo.nvim buffer, use the require("octo").create_buffer(kind, obj, repo, create, hostname) function. This API reference indexes module functions to help you quickly locate the exact arguments needed for configuring buffers.

What user-facing commands are available in the Octo.nvim Neovim plugin?

The Octo.nvim plugin adds specific user-facing commands for interacting with GitHub. This reference indexes these commands, allowing you to quickly find and utilize their functionalities without deep diving into the source code.

Do I need to understand Lua and Neovim plugin architecture to use the Octo.nvim API?

Yes, using the Octo.nvim API requires an understanding of Lua and Neovim plugin architecture. This reference facilitates quick lookup of module functions and their usage for interacting with GitHub, but assumes prior technical knowledge.

How can I look up complex API calls in Octo.nvim that require careful argument consideration?

You can look up complex Octo.nvim API calls using this reference, which provides quick notes identifying potentially complex functions. These notes highlight calls that require careful consideration of arguments and state.

What is the best way to configure an Octo.nvim buffer given a specific buffer number?

The best way to configure an Octo.nvim buffer given a buffer number is to consult this API reference. It lists all available Lua functions within the octo module to help you find the exact configuration function needed.

Why use an API reference index for Octo.nvim instead of reading the source code?

Using an API reference index for Octo.nvim solves the problem of efficiently finding functionalities without deep diving into source code. It provides a quick lookup for module functions and their usage for interacting with GitHub and other services.