Home

Awesome

Telescope-github.nvim

Integration with github cli

Installation

you need to install github cli (version 2.2.0 or greater) first Install Github cli

Packer

use {
    "nvim-telescope/telescope.nvim",
    requires = {
        { "nvim-lua/plenary.nvim" },
        { "nvim-telescope/telescope-github.nvim" },
    },
}

vim-plug

Plug 'nvim-lua/plenary.nvim'
Plug 'nvim-telescope/telescope.nvim'
Plug 'nvim-telescope/telescope-github.nvim'

Setup

require('telescope').load_extension('gh')

Available commands

Telescope gh issues
Telescope gh pull_request
Telescope gh gist
Telescope gh run

"Using lua function
lua require('telescope').extensions.gh.issues()<cr>
lua require('telescope').extensions.gh.pull_request()<cr>
lua require('telescope').extensions.gh.gist()<cr>
lua require('telescope').extensions.gh.run()<cr>

Options

You can add more filter to issue in commands

" filter with author and label
Telescope gh issues author=windwp label=bug

Pull Request

Options Filter

Detail

Queryfilter
authorFilter by author
assigneeFilter by assignee
labelFilter by label
searchFilter by query
stateFilter by state: {open,closed,all}
baseFilter by base branch
limitlimit default = 100

Key mappings

keyUsage
<cr>checkout pull request
<c-t>open web
<c-e>toggle to view detail or diff
<c-r>merge request
<c-a>approve pull request
<c-f>browse modified files

Issue

Options Filter

Detail

Queryfilter
authorFilter by author
assigneeFilter by assignee
mentionFilter by mention
labelFilter by label
milestoneFilter by milestone
searchFilter by query
stateFilter by state: {open,closed,all}
limitlimit default = 100

Key mappings

keyUsage
<cr>insert a reference to the issue
<c-t>open web
<c-l>insert a markdown-link to the issue

Gist

Options Filter

Detail

Queryfilter
publicFilter by public
secretFilter by secret
limitlimit default = 100

Key mappings

keyUsage
<cr>append gist to buffer
<c-t>open web
<c-e>edit gist in TMUX window
<c-d>delete selected gist
<c-n>create new empty gist

Secret

Note: only repository secrets are supported for now

Detail

Key mappings

keyUsage
<cr>append secret name to buffer
<c-e>set new secret value
<c-n>set new secret (name and value)
<c-d>delete selected secret

Workflow runs

Options Filter

Detail

Queryfilter
workflowFilter runs by workflow
limitlimit default = 100
wincmdCommand to open log window, default = 'botright vnew'
wrapWrap lines in log window, default = 'nowrap'
filetypeFiletype to use on log window, default='bash'
cleanmetaTry to clean run log lines, default = 'true'
timeoutTimeout for sync mode, default = '10000'
wait_intervalWait interval for sync mode, default = '5'
modeMode to populate log window, default = 'async'

Key mappings

keyUsage
<cr>open workflow summary/run logs in new window
<c-t>open web
<c-r>request run rerun
<c-a>request run cancel