README.md

Github.SDK

Opiniated Node.js Github SDK

🚧 Requirements

• Node.js version 24 or higher

🚀 Getting Started

This package is available in the Node Package Repository and can be easily installed with npm or yarn

$ npm i @openally/github.sdk
# or
$ yarn add @openally/github.sdk

👀 Usage

import { GithubClient } from "@openally/github.sdk";

const github = new GithubClient({
  token: process.env.GITHUB_TOKEN
});

for await (const pr of github.repos.nodejs.node.pulls()) {
  console.log(pr.title);
}

const tags = await github.repos.OpenAlly["github.sdk"].tags();

const userRepos = await github.users.torvalds.repos();

📚 API

• ApiEndpoint
• GithubClient

Available GitHub APIs:

• repos
• users
• fetchRawFile

---

Proxy provides access to GitHub repository endpoints.

import { repos } from "@openally/github.sdk";

Via GithubClient (recommended for authenticated use)

import { GithubClient } from "@openally/github.sdk";

const { repos } = new GithubClient({
  token: process.env.GITHUB_TOKEN
});

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Thomas.G 💻 📖 👀 ⚠️ 🛡️

Clement Gombauld 📖 👀

License

MIT