Skip to main content

github-docs-scraper

Simple CLI tool to scrape a GitHub repository (optionally a private one) and combine all the Markdown files it finds into a single file. This file can then be easily uploaded to ChatGPT, Deepseek, Qwen, etc.

Usage

Create a .env.local file with the following variables:

  • REPO_OWNER: The owner of the GitHub repository.
  • REPO_NAME: The name of the GitHub repository.
  • GITHUB_TOKEN: The GitHub personal access token.

For instance:

REPO_OWNER=your_org_name
REPO_NAME=your_repo_name
GITHUB_TOKEN=your_github_token

Installation

uv sync
uv run github-docs-scraper

Metadata

Release files for github-docs-scraper 0.1.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 github-docs-scraper 0.1.0
File Size Uploaded
github_docs_scraper-0.1.0.tar.gz 4.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for github-docs-scraper 0.1.0
File Interpreter ABI Platform
github_docs_scraper-0.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 6.1 kB

Release files / github_docs_scraper-0.1.0.tar.gz

Download URL github_docs_scraper-0.1.0.tar.gz
Size 4.0 kB
Tags Source
SHA-256 checksum
How to use checksums
aca05762c998f689e183e069c00c1096384f2f2e51e4c3d0f14e17d331a8a1c1
BLAKE2b-256 checksum
How to use checksums
ce52d72fd549d7af0c66e4f715be279a07616536d04a0a49ee4c0ce4e6f20acb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.4.27

Release files / github_docs_scraper-0.1.0-py3-none-any.whl

Download URL github_docs_scraper-0.1.0-py3-none-any.whl
Size 2.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
22471fa0cac829aed738e458f9b5084d207bd1000c298c638aefc4310cb5d4bf
BLAKE2b-256 checksum
How to use checksums
6b677c9cfdd6aa640b826608c07686a1825247e0e4efb2e6b3f08e33ea66fd8e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.4.27

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files

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