README.md

github.nvim

github.nvim is a comprehensive GitHub REST API client written in Lua for Neovim. Inspired by github.vim, it allows you to interact with GitHub directly from your editor.

Note: This project is under active development. API functions may change without prior notice.

• Installation
• Configuration
• API Reference
  • Issues
  • Pull Requests
  • Repository
  • Releases
  • GitHub Actions
  • Secrets
  • Rulesets
  • Search
  • Users & Organizations
• Credits
• Self-Promotion
• License

Installation

Using nvim-plug

require('plug').add({
    { 'wsdjeg/github.nvim' }
})

Using luarocks

luarocks install github.nvim

Configuration

Set your GitHub token via environment variable or in the setup function:

-- Environment variable (Recommended)
-- export GITHUB_TOKEN=your_token_here

-- Or via setup
require('github').setup({
    token = "your_token_here",
    base_url = "https://api.github.com/", -- For GitHub Enterprise
})

local github = require('github')

-- Access modules
local issues = github.issues
local pulls = github.pulls
-- ... etc

API Reference

Most API functions require user (owner) and repo (repository name) as the first two arguments.

Issues

local M = require('github').issues

M.get(user, repo, id)
M.create_issue(user, repo, issue_data)
M.update_issue(user, repo, id, issue_data)

Pull Requests

local M = require('github').pulls

M.list(user, repo, state)
M.get(user, repo, pull_number)
M.create(user, repo, params)
M.update(user, repo, pull_number, params)
M.merge(user, repo, pull_number, params)
M.create_review(user, repo, pull_number, params)
M.list_reviews(user, repo, pull_number)
M.list_commits(user, repo, pull_number)
M.list_files(user, repo, pull_number)
M.check_merge_status(user, repo, pull_number)

Repository

local M = require('github').repository

M.update(user, repo, repository_data)

Releases

local M = require('github').releases

M.list(user, repo)
M.get_by_id(user, repo, release_id)
M.get_latest(user, repo)
M.get_by_tag(user, repo, tag)
M.create(user, repo, params)
M.update(user, repo, release_id, params)
M.delete(user, repo, release_id)
M.list_assets(user, repo, release_id)
M.upload_asset(user, repo, release_id, file_path, name, label)
M.delete_asset(user, repo, asset_id)

GitHub Actions

local M = require('github').actions

M.list_workflows(user, repo)
M.get_workflow(user, repo, workflow_id)
M.list_workflow_runs(user, repo, params)
M.get_workflow_run(user, repo, run_id)
M.re_run_workflow(user, repo, run_id)
M.cancel_workflow_run(user, repo, run_id)
M.list_jobs_for_run(user, repo, run_id)
M.list_artifacts(user, repo)
M.get_artifact(user, repo, artifact_id)
M.delete_artifact(user, repo, artifact_id)

Secrets

local M = require('github').secrets

M.list_repository_secrets(user, repo)
M.delete_repository_secret(user, repo, secret_name)
M.get_repository_secrets_public_key(user, repo)
M.update_repository_secret(user, repo, secret)

Rulesets

local M = require('github').rulesets

M.get_repository_rules(user, repo)
M.get_branch_rules(user, repo, branch)
M.create_ruleset(user, repo, ruleset)
M.get_repository_ruleset(user, repo, id)
M.update_ruleset(user, repo, id, ruleset)
M.delete_ruleset(user, repo, id)
M.get_ruleset_history(user, repo, id)
M.get_ruleset_version(user, repo, id, version)

Search

local M = require('github').search

M.repositories(query, params)
M.code(query, params)
M.issues(query, params)
M.users(query, params)
M.commits(query, params)

Users & Organizations

local M = require('github').users

M.get_user(username)
M.get_authenticated_user()
M.update_user(params)
M.list_followers(username)
M.list_following(username)
M.list_repos(username, params)

M.get_org(org)
M.update_org(org, params)
M.list_members(org, params)
M.list_repos(org, params)

Credits

• wsdjeg/Github.vim

Self-Promotion

Like this plugin? Star the repository on GitHub.

Love this plugin? Follow me on GitHub.

License

This project is licensed under the GPL-3.0 License.