> For the complete documentation index, see [llms.txt](https://docs.kangal.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.kangal.dev/integrations/github.md).

# GitHub

The GitHub driver reads organization repositories and members, then collects language and open pull-request metadata visible to the credential.

## Required values

| Type          | Field      | Example                              |
| ------------- | ---------- | ------------------------------------ |
| Configuration | `base_url` | `https://api.github.com`             |
| Configuration | `org`      | `acme-platform`                      |
| Secret        | `token`    | Fine-grained or classic access token |

## Provider preparation

1. Create a dedicated fine-grained token where possible.
2. Select only the organization and repositories Kangal should inventory.
3. Grant read access to repository metadata, organization members, and pull requests as required.
4. Record the token once; GitHub may not display it again.

## Configure Kangal

1. Open **Integrations** and select **GitHub**.
2. Keep `https://api.github.com` unless using GitHub Enterprise Server.
3. Enter the organization login, not its display name.
4. Enter the token in the secret field.
5. Save and run a sync.

## Successful result

A successful sync identifies the organization and records repository, member, language, and open pull-request summary metadata available to the token.

## Common failures

* **401:** the token is invalid, expired, or revoked.
* **403:** the token lacks permission, SSO authorization, or has reached a rate limit.
* **404:** the organization is incorrect or hidden from the token.
* **Unsafe outbound URL:** a custom API URL does not meet the HTTPS/egress policy.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.kangal.dev/integrations/github.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.