neovimcraft

plugins configs about

gitgithub

CREATED

2024-09-26

UPDATED

2025-07-14

octohub.nvim is a Neovim plugin for managing and exploring GitHub repositories directly within the editor. It lets you view, filter, and sort repositories, track activity, and access profile and contribution stats, all without leaving Neovim.

✨ Features

Video walkthrough of features

Quickly list and open any GitHub repositories, yours or others, directly from Neovim.
Sort repositories by stars, forks, and other criteria, with support for filtering by type (forks, private repos, etc.).
View all sorts of repository details at a glance, including issues, stars, forks, and more.
Seamless integration with pickers for fuzzy searching and quick access to repositories.
Display GitHub profile stats including recent activity and contributions for any user.
View repository statistics, such as top languages and contribution metrics.
Customizable display options for activity, contribution graphs, and repo stats.

⚡ Setup

⚙️ Requirements

utils.nvim for helper functions
pickme.nvim for picker support
The GitHub CLI tool (gh)
tmux-tea (optional) if you want to use individual sessions for each repository
- Using set -g @tea-default-command 'nvim' is recommended

💻 Installation

-- Lazy nvim
{
    '2kabhishek/octohub.nvim',
    cmd = { 'Octohub' },
    keys = { '<leader>goo' }, -- Add more bindings as needed
    dependencies = {
        '2kabhishek/utils.nvim',
        '2kabhishek/pickme.nvim',
    },
    -- Add your custom configs here, keep it blank for default configs (required)
    opts = {},
},

🚀 Usage

Configuration

octohub.nvim can be configured using the following options:

local octohub = require('octohub')

octohub.setup({
    contribution_icons = { '', '', '', '', '', '', '' }, -- Icons for different contribution levels
    projects_dir = '~/Projects/',     -- Directory where repositories are cloned
    per_user_dir = true,              -- Create a directory for each user
    sort_repos_by = '',               -- Sort repositories by various parameters
    repo_type = '',                   -- Type of repositories to display
    max_contributions = 50,           -- Max number of contributions per day to use for icon selection
    top_lang_count = 5,               -- Number of top languages to display in stats
    event_count = 5,                  -- Number of activity events to show
    window_width = 90,                -- Width in percentage of the window to display stats
    window_height = 60,               -- Height in percentage of the window to display stats
    show_recent_activity = true,      -- Show recent activity in the stats window
    show_contributions = true,        -- Show contributions in the stats window
    show_repo_stats = true,           -- Show repository stats in the stats window
    events_cache_timeout = 3600 * 6,        -- Time in seconds to cache activity events
    contributions_cache_timeout = 3600 * 6, -- Time in seconds to cache contributions data
    repo_cache_timeout = 3600 * 24 * 7,     -- Time in seconds to cache repositories
    username_cache_timeout = 3600 * 24 * 7, -- Time in seconds to cache username
    user_cache_timeout = 3600 * 24 * 7,     -- Time in seconds to cache user data
    add_default_keybindings = true,         -- Add default keybindings for the plugin
    use_new_command = true,                 -- Use the new `Octohub` command
})

Available sort_repos_by options:

created - Sort by creation date, :Octohub repos sort:created
forks - Sort by forks, :Octohub repos sort:forks
issues - Sort by open issues, :Octohub repos sort:issues
language - Sort by language, :Octohub repos sort:language
name - Sort by name, :Octohub repos sort:name
pushed - Sort by last push, :Octohub repos sort:pushed
size - Sort by size, :Octohub repos sort:size
stars - Sort by stars, :Octohub repos sort:stars
updated - Sort by last update, :Octohub repos sort:updated

Available repo_type options:

archived - Archived repositories, :Octohub repos type:archived
forked - Forked repositories, :Octohub repos type:forked
private - Private repositories, :Octohub repos type:private
starred - Starred repositories, :Octohub repos type:starred
template - Template repositories, :Octohub repos type:template

Note: The sort_repos_by and repo_type options match the start of keywords, you can expand them for readability, sort:updated is same as sort:update.

Commands

octohub.nvim provides a unified command interface with tab completion support:

Main Commands

:Octohub repos [user] [sort:<option>] [type:<option>]: Displays repositories for a given user, sorted by specified criteria.
- Ex: :Octohub repos 2kabhishek sort:updated type:forked - Display all forked repositories for 2kabhishek, sorted by last update.
- Ex: :Octohub repos type:starred - Display all repositories starred by the current user.
- Ex: :Octohub - Same as :Octohub repos for the current user.
:Octohub repo <name> [user]: Opens a specified repository, optionally by a user.
- Ex: :Octohub repo octohub.nvim - Clone the repository octohub.nvim from the current user.
- Ex: :Octohub repo octohub.nvim 2kabhishek - Clone the repository octohub.nvim from the user 2kabhishek.
:Octohub stats [user]: Displays all stats (activity, contributions, repository data).
- Ex: :Octohub stats theprimeagen shows stats for theprimeagen.
:Octohub stats activity [user] [count:N]: Displays recent activity for a user, with an optional count.
- Ex: :Octohub stats activity count:20 shows the last 20 activity events for the current user.
:Octohub stats contributions [user]: Displays contribution stats for a user.
:Octohub stats repo [user]: Displays statistics for the repositories of a given user.
- Ex: :Octohub stats repo 2kabhishek - Display statistics for the repositories of the user 2kabhishek.
:Octohub web profile [user]: Opens the GitHub profile of a user in your browser.
:Octohub web repo: Opens the current repository in the browser.

Command Completion

All new Octohub commands support tab completion:

Subcommands: repos, repo, stats, web
Parameters: sort:created, sort:forks, type:archived, type:private, etc.
Context-aware completion based on the current command

Utility Commands

UtilsClearCache[prefix]: Clears all the cache for a given prefix. Provided by utils.nvim.
- Ex: :UtilsClearCache username - Clears the cache for username

If the user parameter is not provided, the plugin will use the current authenticated username from gh

Deprecated Commands (Backward Compatibility)

⚠️ DEPRECATION NOTICE: The following commands are deprecated and will be removed in a future version. Please migrate to the new Octohub commands above. More information: https://github.com/2kabhishek/octohub.nvim/issues/13

The original commands are still available for backward compatibility:

:OctoRepos, :OctoRepo, :OctoStats, :OctoActivityStats, :OctoContributionStats, :OctoRepoStats, :OctoProfile, :OctoRepoWeb
All the OctoReposBy* and OctoReposType* commands

Migration Guide:

:OctoRepos → :Octohub repos
:OctoReposBySize → :Octohub repos sort:size
:OctoReposTypePrivate → :Octohub repos type:private
:OctoRepo → :Octohub repo
:OctoStats → :Octohub stats
:OctoActivityStats → :Octohub stats activity
:OctoContributionStats → :Octohub stats contributions
:OctoRepoStats → :Octohub stats repo
:OctoProfile → :Octohub web profile
:OctoRepoWeb → :Octohub web repo

Keybindings

By default, these are the configured keybindings.

Keybinding	Command	Description
`<leader>goo`	`:Octohub repos<CR>`	All Repos
`<leader>gob`	`:Octohub repos sort:size<CR>`	Repos by Size
`<leader>goc`	`:Octohub repos sort:created<CR>`	Repos by Created
`<leader>gof`	`:Octohub repos sort:forks<CR>`	Repos by Forks
`<leader>goi`	`:Octohub repos sort:issues<CR>`	Repos by Issues
`<leader>gol`	`:Octohub repos sort:language<CR>`	Repos by Language
`<leader>gos`	`:Octohub repos sort:stars<CR>`	Repos by Stars
`<leader>gou`	`:Octohub repos sort:updated<CR>`	Repos by Updated
`<leader>goU`	`:Octohub repos sort:pushed<CR>`	Repos by Pushed
`<leader>goA`	`:Octohub repos type:archived<CR>`	Archived Repos
`<leader>goF`	`:Octohub repos type:forked<CR>`	Forked Repos
`<leader>goP`	`:Octohub repos type:private<CR>`	Private Repos
`<leader>goS`	`:Octohub repos type:starred<CR>`	Starred Repos
`<leader>goT`	`:Octohub repos type:template<CR>`	Template Repos
`<leader>goa`	`:Octohub stats activity<CR>`	Activity Stats
`<leader>gog`	`:Octohub stats contributions<CR>`	Contribution Graph
`<leader>gor`	`:Octohub stats repo<CR>`	Repo Stats
`<leader>got`	`:Octohub stats<CR>`	All Stats
`<leader>gop`	`:Octohub web profile<CR>`	Open GitHub Profile
`<leader>gow`	`:Octohub web repo<CR>`	Open Repo in Browser

I recommend customizing these keybindings based on your preferences.

You can also add the following to your which-key configuration: { '<leader>go', group = 'Octohub' },

Telescope Integration

octohub.nvim adds a Telescope extension for easy searching and browsing of repositories.

Make sure that you define the picker_provider as telescope in your pickme.nvim configuration.

To use this extension, add the following code to your configuration:

local telescope = require('telescope')

telescope.load_extension('repos')

You can now use the following command to show repositories in Telescope: :Telescope repos

Help

Run :help octohub to view these docs in Neovim.

🏗️ What's Next

Add more tests
You tell me!

⛅ Behind The Code

🌈 Inspiration

I use GitHub quite a bit and wanted to get all of my most used activities done from Neovim.

💡 Challenges/Learnings

The main challenges were figuring out how to interact with the GitHub API and how to display the data in a user-friendly way.
I learned about Lua's powerful features for handling data structures and Neovim's extensibility.

🔍 More Info

nerdy.nvim — Find nerd glyphs easily
tdo.nvim — Fast and simple notes in Neovim
termim.nvim — Neovim terminal improved

⭐ hit the star button if you found this useful ⭐

neovimcraft

neovimcraft

2KAbhishek/octohub.nvim

CREATED

2024-09-26

UPDATED

2025-07-14

✨ Features

⚡ Setup

⚙️ Requirements

💻 Installation

🚀 Usage

Configuration

Commands

Main Commands

Command Completion

Utility Commands

Deprecated Commands (Backward Compatibility)

Keybindings

Telescope Integration

Help

🏗️ What's Next

⛅ Behind The Code

🌈 Inspiration

💡 Challenges/Learnings

🔍 More Info