Skip to main content

langchain-github

LangChain retrievers and loaders for GitHub repositories, issues and discussions.

  • GitHubRepoRetriever: ask a question about a repo and get the best code and doc passages, each with a permalink to the exact commit and lines. Works on any branch, tag or commit.
  • GitHubIssuesRetriever: describe a problem or paste a traceback and get the matching issue, discussion or comment, with how it was resolved (fixed, answered, closed, wontfix, duplicate, open) and the PR that closed it.
  • GitHubRepositoryLoader, GitHubIssuesLoader: the same data as plain Documents.

Installation

pip install langchain-github

No token is needed to try it, but without signing in GitHub allows only 60 requests an hour. To sign in once, install the GitHub CLI and run:

gh auth login

The package picks up that login automatically. It also reads GITHUB_TOKEN or GH_TOKEN, or you can pass token=. Public repos need no special permissions.

Usage

from langchain_github import GitHubRepoRetriever, GitHubIssuesRetriever

docs = GitHubRepoRetriever(repo="pallets/click", k=3).invoke(
    "how are environment variables read for options?"
)
print(docs[0].metadata["url"])  # https://github.com/pallets/click/blob/<sha>/docs/options.md#L677-L690

issues = GitHubIssuesRetriever(repo="psf/requests").invoke("requests hang when all sockets are in use")
m = issues[0].metadata
print(m["title"], m["resolution"], m["resolved_by_urls"], m["url"])

Both retrievers support ainvoke, and k can be set on the retriever or per call. Use with GitHubRepoRetriever(...) as retriever: (or call retriever.close()) to close connections when you are done.

Use with a chat model

from langchain.chat_models import init_chat_model
from langchain_core.output_parsers import StrOutputParser
from langchain_core.prompts import ChatPromptTemplate
from langchain_core.runnables import RunnablePassthrough

retriever = GitHubRepoRetriever(repo="pallets/click", k=4)
prompt = ChatPromptTemplate.from_messages([
    ("system", "Answer from these passages and cite their links.\n\n{context}"),
    ("human", "{question}"),
])
format_docs = lambda docs: "\n\n".join(f"[{d.metadata['url']}]\n{d.page_content}" for d in docs)

chain = (
    {"context": retriever | format_docs, "question": RunnablePassthrough()}
    | prompt | init_chat_model("anthropic:claude-sonnet-5-5") | StrOutputParser()
)
print(chain.invoke("how are environment variables read for options?"))

Key options

Option Effect Example What the example does
ref= Branch, tag or commit (repo retriever). GitHubRepoRetriever(repo="pallets/click", ref="8.1.7") Searches the code as it was at release 8.1.7, not the latest version. Links point to that exact commit.
embeddings= Any LangChain Embeddings; turns on hybrid ranking. Recommended for natural-language questions. GitHubRepoRetriever(repo="pallets/click", embeddings=Fast()) (Fast is defined below) Matches on meaning as well as words, so "env vars" also finds text about "environment variables".
cache_dir= Cache downloads (and embeddings, if used) so a new commit refetches only changed files and a restart is fast. GitHubRepoRetriever(repo="pallets/click", cache_dir=".cache/gh") Saves downloaded files in .cache/gh. The next run reuses them and only fetches what changed.
include / exclude / extensions Filter files with gitignore-style globs. GitHubRepoRetriever(repo="pallets/click", include=["docs/**"], extensions=[".md"]) Only searches Markdown files under docs/, so code and tests never show up in results.
mode= Issues retriever: index, search or auto (default). GitHubIssuesRetriever(repo="pallets/click", mode="search") Asks GitHub's own search for candidate issues instead of downloading every issue first.

Requests stay within GitHub's limits: 60 per hour when you are not signed in and 5,000 per hour when you are (run gh auth login once to sign in). Searches are paced at 30 per minute, and meaning-based (hybrid) issue searches at 10 per minute. If GitHub asks to slow down, the package waits and retries.

embeddings= takes an object, not a string. This free one runs on your machine (pip install fastembed), and any other LangChain embeddings class, such as OpenAIEmbeddings(), works the same way:

from fastembed import TextEmbedding
from langchain_core.embeddings import Embeddings

class Fast(Embeddings):
    def __init__(self):
        self.model = TextEmbedding("BAAI/bge-small-en-v1.5")  # small model, downloaded once
    def embed_documents(self, texts):
        return [v.tolist() for v in self.model.embed(texts)]
    def embed_query(self, text):
        return next(iter(self.model.embed([text]))).tolist()

The first query builds the index, which takes a couple of minutes on a laptop for a repo like click. Later queries are fast. With cache_dir= that work is saved, so the next run does not repeat it.

How well does it work?

  • Repos: finds the right passages noticeably better than plain keyword search, and about as well as a standard vector store, while also giving you exact line links, any branch or tag, and quick updates when the repo changes.
  • Issues: about as good as GitHub's own search at finding the right issue, and it adds what search does not: discussions, the closing pull request, and whether the problem was fixed, answered or closed as a duplicate.
  • Wording matters: by default it matches words, so it works best when your question uses the project's own terms. For casual or paraphrased questions, pass embeddings= so it also matches meaning.

Limits

  • Read-only. Private repositories need a token that can read them.
  • Discussions are only included when you are signed in, because GitHub does not serve them to anonymous users. Run gh auth login once to enable them.
  • GitHub search caps at 1,000 results. Very large monorepos are capped by max_archive_mb.
  • The index is held in memory per retriever instance.
  • Not an official GitHub product.

Development

pip install -e '.[dev]' && pytest              # offline tests
GITHUB_LIVE=1 GITHUB_TOKEN=... pytest -m live  # live tests

MIT licensed. Issues and pull requests welcome at github.com/daivikawasthi01/langchain-github.

Metadata

Release files for langchain-github 0.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for langchain-github 0.2.0
File Size Uploaded Provenance Actions
langchain_github-0.2.0.tar.gz 58.7 kB With provenance Details for langchain_github-0.2.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for langchain-github 0.2.0
File Interpreter ABI Platform Actions
langchain_github-0.2.0-py3-none-any.whl Python 3 none any Details for langchain_github-0.2.0-py3-none-any.whl

Total release size: 98.7 kB

Release files / langchain_github-0.2.0.tar.gz

Download URL langchain_github-0.2.0.tar.gz
Size 58.7 kB
Tags Source
SHA-256 checksum
How to use checksums
4be3bdc288ec7a90e188da786f73458e24927cfbf8375e0e219c8171652b1ee1
BLAKE2b-256 checksum
How to use checksums
9f053b5dfcbb6152315d9ff18b51b31f60fd47eb0963324ee0507e62fafeff66
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 5, 2026.

Transparency log

Release files / langchain_github-0.2.0-py3-none-any.whl

Download URL langchain_github-0.2.0-py3-none-any.whl
Size 40.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a96a88f872ca04211c0086e0952c8429131e87b80f5d495aa00dfdfc19118e27
BLAKE2b-256 checksum
How to use checksums
54ff3957561dfaeabacca6bfb98ca6aa9d25fff81d39c336ffc5550cdf97c694
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 5, 2026.

Transparency log

Security for langchain-github 0.2.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for langchain_github-0.2.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 5, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.2.0 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page