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.
neovim
gh
CLIset -g @tea-default-command 'nvim'
for a better experience-- Lazy nvim
{
'2kabhishek/octohub.nvim',
cmd = {
'OctoRepos',
'OctoRepo',
'OctoStats',
'OctoActivityStats',
'OctoContributionStats',
'OctoRepoStats',
'OctoProfile',
'OctoRepoWeb',
},
-- Change these if you do not want to use default keybindings
keys = {
'<leader>goa',
'<leader>goc',
'<leader>gof',
'<leader>gog',
'<leader>goh',
'<leader>goi',
'<leader>goo',
'<leader>gop',
'<leader>gor',
'<leader>gos',
'<leader>got',
'<leader>gou',
'<leader>gow',
},
dependencies = {
'2kabhishek/utils.nvim',
'nvim-telescope/telescope.nvim'
},
-- Add your custom configs here, keep it blank for default configs (required)
opts = {},
},
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
})
sort_repos_by
options: stars
, forks
, updated
, created
, pushed
, name
, size
, watchers
, issues
repo_type
options: private
, fork
, template
, archived
octohub.nvim
adds the following commands:
:OctoRepos [user] [sort:<sort_repos_by>] [type:<repo_type>]
: Displays the repositories for a given user, sorted by the specified criteria.:OctoRepos 2kabhishek sort:updated type:fork
- Display all forked repositories for the user 2kabhishek
, sorted by the last update.:OctoRepo <repo_name> [user]
: Opens a specified repository, optionally by a user.:OctoRepo octohub.nvim
- Clone the repository octohub.nvim
from the current user.:OctoRepo 2kabhishek octohub.nvim
- Clone the repository octohub.nvim
from the user 2kabhishek
.:OctoRepoStats [user]
: Displays statistics for the repositories of a given user.:OctoRepoStats 2kabhishek
- Display statistics for the repositories of the user 2kabhishek
.:OctoRepoWeb
- Opens the current repository in the browser.OctoStats
: Displays all stats (activity, contributions, repository data).:OctoStats theprimeagen
shows stats for theprimeagen
.OctoActivityStats [username] [count:N]
: Displays recent activity for a user, with an optional count.:OctoActivityStats count:20
shows the last 20 activity events for the current user.OctoContributionStats [username]
: Displays contribution stats for a user.OctoProfile [username]
: Opens the GitHub profile of a user in your browser.UtilsClearCache[prefix]
: Clears all the cache for a given prefix. Provided by utils.nvim.:UtilsClearCache username
- Clears the cache for username
If the user
parameter is not provided, the plugin will use the current authenticated username from gh
By default, these are the configured keybindings.
Keybinding | Command | Description |
---|---|---|
<leader>goo |
:OctoRepos<CR> |
All Repos |
<leader>gos |
:OctoRepos sort:stars<CR> |
Top Starred Repos |
<leader>goi |
:OctoRepos sort:issues<CR> |
Repos With Issues |
<leader>gou |
:OctoRepos sort:updated<CR> |
Recently Updated Repos |
<leader>gop |
:OctoRepos type:private<CR> |
Private Repos |
<leader>gof |
:OctoRepos type:fork<CR> |
Forked Repos |
<leader>goc |
:OctoRepo<CR> |
Open / Clone Repo |
<leader>got |
:OctoStats<CR> |
All Stats |
<leader>goa |
:OctoActivityStats<CR> |
Activity Stats |
<leader>gog |
:OctoContributionStats<CR> |
Contribution Graph |
<leader>gor |
:OctoRepoStats<CR> |
Repo Stats |
<leader>gop |
:OctoProfile<CR> |
Open GitHub Profile |
<leader>gow |
:OctoRepoWeb<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' },
octohub.nvim
adds a Telescope extension for easy searching and browsing of repositories.
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
Run :help octohub
to view these docs in Neovim.
I use GitHub quite a bit and wanted to get all of my most used activities done from Neovim.
⭐ hit the star button if you found this useful ⭐
Source | Blog | Twitter | LinkedIn | More Links | Other Projects