{"id":23178402,"url":"https://github.com/bn-l/githubextractor","last_synced_at":"2026-03-05T16:34:25.037Z","repository":{"id":229891230,"uuid":"777743772","full_name":"bn-l/GithubExtractor","owner":"bn-l","description":"List and download repositories or individual files quickly","archived":false,"fork":false,"pushed_at":"2024-09-01T05:34:23.000Z","size":8822,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-12-04T02:06:06.326Z","etag":null,"topics":["archive","download","downloader","fast","github","list","repo","repository","single-file"],"latest_commit_sha":null,"homepage":"https://bn-l.github.io/GithubExtractor/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bn-l.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-03-26T12:34:34.000Z","updated_at":"2024-06-01T11:19:57.000Z","dependencies_parsed_at":"2024-05-01T07:23:53.573Z","dependency_job_id":"9196f1c7-5045-411a-8553-f5a6d41d38f4","html_url":"https://github.com/bn-l/GithubExtractor","commit_stats":null,"previous_names":["bn-l/githubextractor"],"tags_count":35,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bn-l%2FGithubExtractor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bn-l%2FGithubExtractor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bn-l%2FGithubExtractor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bn-l%2FGithubExtractor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bn-l","download_url":"https://codeload.github.com/bn-l/GithubExtractor/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230231438,"owners_count":18193919,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["archive","download","downloader","fast","github","list","repo","repository","single-file"],"created_at":"2024-12-18T07:11:01.515Z","updated_at":"2026-03-05T16:34:24.976Z","avatar_url":"https://github.com/bn-l.png","language":"HTML","readme":"\n# github-extractor\n\n\u003cdiv align=\"center\"\u003e\n    \u003cimg src=\"./media/logo-1024.webp\" alt=\"header logo: Github Extractor\" width=\"35%\" height=\"35%\"\u003e\n\u003c/div\u003e\n\n\n\nList github repositories and download individual files or whole repos conveniently. Faster than clone depth=1 for an entire repo and much faster if you just need a single file. Also works on the [cli](https://github.com/bn-l/GithubExtractorCLI).\n\n[Api Documentation](https://bn-l.github.io/GithubExtractor/api/GithubExtractor/)\n \n\u003cdiv align=\"center\" style=\"display: flex; justify-content: center; gap: 10px;\"\u003e\n\u003cimg src=\"https://github.com/bn-l/GithubExtractor/actions/workflows/ci.yml/badge.svg\" alt=\"Continuous Integration status badge\"\u003e   \u003ca href=\"coverage/coverage.txt\"\u003e\u003cimg src=\"./media/coverage-badge.svg\" alt=\"Code coverage badge\"\u003e\u003c/a\u003e  \u003ca href=\"https://github.com/bn-l/GithubExtractor/issues\"\u003e\u003cimg src=\"https://img.shields.io/github/issues/bn-l/GithubExtractor\" alt=\"GitHub issues badge\"\u003e\u003c/a\u003e  \u003ca href=\"https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request\"\u003e \u003cimg src=\"https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat\" alt=\"Pull requests welcome badge\"\u003e \u003c/a\u003e\n\u003c/div\u003e\n\n\n\n\n\n\n\n\n\n# Quickstart\n\n## Install\n\n```bash\nnpm install github-extractor\n```\n\n## Usage \n\n### Initialize\n\n\n\n```typescript\nimport githubExtractor from \"github-extractor\";\n\nconst ghe = new githubExtractor({\n    owner: \"octocat\",\n    repo: \"Spoon-Knife\",\n    // The default: Readme.md is a different file to README.md\n    caseInsensitive: false, \n})\n```\n\n### List\n\n ```typescript\n const fullList = await ghe.list();\n \n // List a repo non recursively to only show the top-level items (recursive is true by default):\n const topLevel = await ghe.list({ recursive: false }); \n \n // Show any conflicts that might arise if downloading to `dest`:\n const conflicts = await ghe.list({ dest: \"some/path\", conflictsOnly: true });\n    \n ```\n\n### Download\n\n```typescript\nawait ghe.downloadTo({ dest: \"some/path\" });\n```\n\nUsing `selectedPaths`:\nDownloads only the paths in the repo specified. Do not prefix with repo name. It will \nstop downloading once it has the file. This can make getting a single file from a large \nrepo very fast.\n\n```typescript\n// Save just `boo.jpg`:\nawait ghe.downloadTo({ dest: \"some/path\", selectedPaths: [\"someFolder/boo.jpg\"] });\n\n// just the `README.md` file: \nawait ghe.downloadTo({ dest: \"some/path\", selectedPaths: [\"README.md\"] });\n   \n```\n\n\nThere are more options and they're all documented using jsdoc so will appear in intellisense.\nThere is also the [api Documentation](https://bn-l.github.io/GithubExtractor/api/GithubExtractor/).\n\n\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbn-l%2Fgithubextractor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbn-l%2Fgithubextractor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbn-l%2Fgithubextractor/lists"}