Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.cake.ai/llms.txt

Use this file to discover all available pages before exploring further.

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
Use a GitHub App rather than asking users for personal access tokens. This gives you:
  • a managed integration boundary
  • user linking through GitHub’s web flow
  • better separation between app-level setup and user-level authorization

​
High-Level Flow

  1. Create or register the GitHub App for the Cake Agents environment.
  2. Configure the callback URL used by Cake Agents for GitHub user linking.
  3. Store the GitHub App credentials securely for the control plane.
  4. Confirm that the application shows GitHub as available for user linking.

​
Configure the GitHub App

  1. Create a new GitHub App in your organization (or use an existing one dedicated to Cake Agents).
  2. Set the app’s callback URL to the GitHub linking endpoint for your Cake Agents control plane.
  3. Choose repository permissions that match the workflows you want Cake Agents to run.
Typical permissions for PR and commit workflows include:
  • repository contents (read/write)
  • pull requests (read/write)
  • metadata (read)
If you plan to rely on additional GitHub features (issues, checks, actions, etc.), add only what you need and validate in a test repo.

​
Store Credentials in Cake Agents

Store the GitHub App credentials as environment-scoped secrets for the control plane. After saving, confirm GitHub linking is available in user settings.

​
Verify It Works

  1. In Cake Agents, confirm the GitHub linking option is visible.
  2. Link a test user account.
  3. In a test session, verify Cake Agents can:
  • open a pull request
  • push a commit

​
Operational Notes

  • GitHub admin setup is environment-scoped.
  • User GitHub linking is user-scoped.
  • If the GitHub App is not registered correctly, user linking cannot start.
  • If a user token is revoked or expires beyond recovery, that user must link GitHub again.
After GitHub is configured for the environment, send users to Link GitHub.