Set Up GitHub

Administrators set up GitHub once for the Cake Agents environment. Individual users then link their own GitHub accounts separately.

​

What This Enables

GitHub setup allows Cake Agents to:

• open pull requests
• push commits on behalf of linked users
• use GitHub-backed workflows inside sessions

​

Admin Responsibilities

As an admin, you are responsible for:

• registering the GitHub App used by Cake Agents
• configuring the app so the control plane can complete the user linking flow
• ensuring the environment can store the app credentials securely

​

Requirements

You must be an organization-level admin on GitHub to proceed.

​

Instructions

​

Register the GitHub App

1. In Cake Agents, go to Settings → GitHub App.
2. Enter the name your GitHub organization. We will use this to create a GitHub App for your organization’s instance of Cake Agents.
3. Click “Continue to GitHub”.
4. For “GitHub App name” append your company name. For example “Cake Agents - ACME Corp”.
5. Click “Create GitHub App for <your org>

​

Install the GitHub App

1. Back in Cake Agents, navigate to “Settings → GitHub install (org)”.
2. Click “Continue to GitHub”.
3. Select the repositories you’d like to enable (this can be changed later), then click “Install”.

​

Test the integration

You can test the integration by linking your GitHub account to your Cake Agents user and verifying that the New Session page shows all the expected GitHub repos.