Integrations
GitHub Integration
This guide walks you through the process of installing OpenHands Cloud for your GitHub repositories. Once set up, it will allow OpenHands to work with your GitHub repository through the Cloud UI or straight from GitHub!
Prerequisites
- Signed in to OpenHands Cloud with a GitHub account.
Adding GitHub Repository Access
You can grant OpenHands access to specific GitHub repositories:- Click on
Add GitHub reposon the landing page. - Select your organization and choose the specific repositories to grant OpenHands access to.
OpenHands permissions
OpenHands permissions
- OpenHands requests short-lived tokens (8-hour expiration) with these permissions:
- Actions: Read and write
- Commit statuses: Read and write
- Contents: Read and write
- Issues: Read and write
- Metadata: Read-only
- Pull requests: Read and write
- Webhooks: Read and write
- Workflows: Read and write
- Repository access for a user is granted based on:
- Permission granted for the repository
- User’s GitHub permissions (owner/collaborator)
- Click
Install & Authorize.
Modifying Repository Access
You can modify GitHub repository access at any time by:- Selecting
Add GitHub reposon the landing page or - Visiting the Settings page and selecting
Configure GitHub Repositoriesunder theIntegrationstab
Working With GitHub Repos in Openhands Cloud
Once you’ve granted GitHub repository access, you can start working with your GitHub repository. Use theselect a repo
and select a branch dropdowns to select the appropriate repository and branch you’d like OpenHands to work on. Then
click on Launch to start the conversation!
Working on Github Issues and Pull Requests Using Openhands
Giving GitHub repository access to OpenHands also allows you to work on GitHub issues and pull requests directly.Working with Issues
On your repository, label an issue withopenhands or add a message starting with @openhands. OpenHands will:
- Comment on the issue to let you know it is working on it.
- You can click on the link to track the progress on OpenHands Cloud.
- Open a pull request if it determines that the issue has been successfully resolved.
- Comment on the issue with a summary of the performed tasks and a link to the PR.
Working with Pull Requests
To get OpenHands to work on pull requests, mention@openhands in the comments to:
- Ask questions
- Request updates
- Get code explanations
@openhands mention functionality in pull requests only works if the pull request is both to and from a repository that you have added through the interface. This is because OpenHands needs appropriate permissions to access both repositories.
Next Steps
- Learn about the Cloud UI.
- Use the Cloud API to programmatically interact with OpenHands.