> For the complete documentation index, see [llms.txt](https://help.swarmia.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.swarmia.com/settings/integrations/code-hosting-platforms/github.md).

# GitHub

## Connecting GitHub Cloud to Swarmia

1. Ensure you have [the necessary admin permissions on GitHub](https://docs.github.com/en/github-ae@latest/developers/apps/getting-started-with-apps/differences-between-github-apps-and-oauth-apps#who-can-install-github-apps-and-authorize-oauth-apps)
2. Navigate to [code hosting settings in Swarmia](https://app.swarmia.com/settings/version-control), click **Connect**, and select GitHub Cloud
3. Select the GitHub organization
4. Select the repositories you want to sync to Swarmia
5. Review the required authorizations, and click *Install & Authorize*

{% hint style="info" %}
All users in your Swarmia organization can read the metadata (such as pull request names) for all integrated repositories in Swarmia. Use caution if working with sensitive repositories.\
\
Swarmia collects the file names and sizes of commits from the source code. **We do not store your source code.** [Learn more about data security.](https://www.swarmia.com/security/)
{% endhint %}


---

# 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://help.swarmia.com/settings/integrations/code-hosting-platforms/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.