{"id":13434656,"url":"https://github.com/github-tools/github","last_synced_at":"2026-04-08T14:32:43.206Z","repository":{"id":2650622,"uuid":"3640925","full_name":"github-tools/github","owner":"github-tools","description":"A higher-level wrapper around the Github API. Intended for the browser.","archived":false,"fork":false,"pushed_at":"2022-09-04T15:10:53.000Z","size":2635,"stargazers_count":3685,"open_issues_count":175,"forks_count":790,"subscribers_count":122,"default_branch":"master","last_synced_at":"2025-12-06T20:09:44.407Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/github-tools.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2012-03-06T18:08:53.000Z","updated_at":"2025-12-05T08:37:47.000Z","dependencies_parsed_at":"2022-07-08T19:47:36.507Z","dependency_job_id":null,"html_url":"https://github.com/github-tools/github","commit_stats":null,"previous_names":["michael/github"],"tags_count":45,"template":false,"template_full_name":null,"purl":"pkg:github/github-tools/github","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/github-tools%2Fgithub","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/github-tools%2Fgithub/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/github-tools%2Fgithub/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/github-tools%2Fgithub/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/github-tools","download_url":"https://codeload.github.com/github-tools/github/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/github-tools%2Fgithub/sbom","scorecard":{"id":428133,"data":{"date":"2025-08-11","repo":{"name":"github.com/github-tools/github","commit":"540813873309d1889aa50e0708f10baf90b08890"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.5,"checks":[{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Code-Review","score":6,"reason":"Found 9/14 approved changesets -- score normalized to 6","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: npmCommand not pinned by hash: release.sh:11","Info:   0 out of   1 npmCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: BSD 3-Clause \"New\" or \"Revised\" License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 26 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-19T02:41:59.150Z","repository_id":2650622,"created_at":"2025-08-19T02:41:59.150Z","updated_at":"2025-08-19T02:41:59.150Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":27551641,"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","status":"online","status_checked_at":"2025-12-06T02:00:06.463Z","response_time":60,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2024-07-31T03:00:19.926Z","updated_at":"2025-12-12T03:02:25.160Z","avatar_url":"https://github.com/github-tools.png","language":"JavaScript","readme":"# Maintainers wanted\n[Apply within](https://github.com/github-tools/github/issues/539)\n\n# Github.js\n\n[![Downloads per month](https://img.shields.io/npm/dm/github-api.svg?maxAge=2592000)][npm-package]\n[![Latest version](https://img.shields.io/npm/v/github-api.svg?maxAge=3600)][npm-package]\n[![Gitter](https://img.shields.io/gitter/room/github-tools/github.js.svg?maxAge=2592000)][gitter]\n[![Travis](https://img.shields.io/travis/github-tools/github.svg?maxAge=60)][travis-ci]\n[![Codecov](https://img.shields.io/codecov/c/github/github-tools/github.svg?maxAge=2592000)][codecov]\n\n`Github.js` provides a minimal higher-level wrapper around Github's API.\n\n## Usage\n\n```javascript\n/*\n   Data can be retrieved from the API either using callbacks (as in versions \u003c 1.0)\n   or using a new promise-based API. The promise-based API returns the raw Axios\n   request promise.\n */\nimport GitHub from 'github-api';\n\n// unauthenticated client\nconst gh = new GitHub();\nlet gist = gh.getGist(); // not a gist yet\ngist.create({\n   public: true,\n   description: 'My first gist',\n   files: {\n      \"file1.txt\": {\n         content: \"Aren't gists great!\"\n      }\n   }\n}).then(function({data}) {\n   // Promises!\n   let createdGist = data;\n   return gist.read();\n}).then(function({data}) {\n   let retrievedGist = data;\n   // do interesting things\n});\n```\n\n```javascript\nvar GitHub = require('github-api');\n\n// basic auth\nvar gh = new GitHub({\n   username: 'FOO',\n   password: 'NotFoo'\n   /* also acceptable:\n      token: 'MY_OAUTH_TOKEN'\n    */\n});\n\nvar me = gh.getUser(); // no user specified defaults to the user for whom credentials were provided\nme.listNotifications(function(err, notifications) {\n   // do some stuff\n});\n\nvar clayreimann = gh.getUser('clayreimann');\nclayreimann.listStarredRepos(function(err, repos) {\n   // look at all the starred repos!\n});\n```\n\n## API Documentation\n\n[API documentation][docs] is hosted on github pages, and is generated from JSDoc; any contributions\nshould include updated JSDoc.\n\n## Installation\n`Github.js` is available from `npm` or [unpkg][unpkg].\n\n```shell\nnpm install github-api\n```\n\n```html\n\u003c!-- just github-api source (5.3kb) --\u003e\n\u003cscript src=\"https://unpkg.com/github-api/dist/GitHub.min.js\"\u003e\u003c/script\u003e\n\n\u003c!-- standalone (20.3kb) --\u003e\n\u003cscript src=\"https://unpkg.com/github-api/dist/GitHub.bundle.min.js\"\u003e\u003c/script\u003e\n```\n\n## Compatibility\n`Github.js` is tested on node's LTS and current versions.\n\n[codecov]: https://codecov.io/github/github-tools/github?branch=master\n[docs]: http://github-tools.github.io/github/\n[gitter]: https://gitter.im/github-tools/github\n[npm-package]: https://www.npmjs.com/package/github-api/\n[unpkg]: https://unpkg.com/github-api/\n[travis-ci]: https://travis-ci.org/github-tools/github\n\n## Contributing\n\nWe welcome contributions of all types! This section will guide you through setting up your development environment.\n\n### Setup\n\n1. [Install Node](https://nodejs.org/en/) version 8,10 or 11. It can often help to use a Node version switcher such as [NVM](https://github.com/nvm-sh/nvm).\n2. Fork this repo to your GitHub account.\n3. Clone the fork to your development machine (`git clone https://github.com/{YOUR_USERNAME}/github`).\n4. From the root of the cloned repo, run `npm install`.\n5. Email jaredrewerts@gmail.com with the subject **GitHub API - Personal Access Token Request**\n\nA personal access token for our test user, @github-tools-test, will be generated for you.\n\n6. Set the environment variable `GHTOOLS_USER` to `github-tools-test`.\n\n`export GHTOOLS_USER=github-tools-test`\n\n7. Set the environment variable `GHTOOLS_PASSWORD` to the personal access token that was generated for you.\n\n`export GHTOOLS_PASSWORD={YOUR_PAT}`\n\n**NOTE** Windows users can use [this guide](http://www.dowdandassociates.com/blog/content/howto-set-an-environment-variable-in-windows-command-line-and-registry/) to learn about setting environment variables on Windows.\n\n### Tests\n\nThe main way we write code for `github-api` is using test-driven development. We use Mocha to run our tests. Given that the bulk of this library is just interacting with GitHub's API, nearly all of our tests are integration tests. \n\nTo run the test suite, run `npm run test`.\n","funding_links":[],"categories":["KSP","JavaScript"],"sub_categories":["Mini Program"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgithub-tools%2Fgithub","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgithub-tools%2Fgithub","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgithub-tools%2Fgithub/lists"}