Skip to main content

​
Prerequisites

​
Adding GitHub Repository Access

You can grant OpenHands access to specific GitHub repositories:
  1. Click on + Add GitHub Repos in the repository selection dropdown.
  2. Select your organization and choose the specific repositories to grant OpenHands access to.
  • 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)
  1. Click Install & Authorize.

​
Modifying Repository Access

You can modify GitHub repository access at any time by:
  • Selecting + Add GitHub Repos in the repository selection dropdown or
  • Visiting the Settings > Integrations page and selecting Configure GitHub Repositories

​
Working With GitHub Repos in Openhands Cloud

Once you’ve granted GitHub repository access, you can start working with your GitHub repository. Use the Open Repository section to select the appropriate repository and branch you’d like OpenHands to work on. Then click on Launch to start the conversation! Connect Repo

​
Working on GitHub Issues and Pull Requests Using Openhands

To allow OpenHands to work directly from GitHub directly, you must give OpenHands access to your repository. Once access is given, you can use OpenHands by labeling the issue or by tagging @openhands.

​
Working with Issues

On your repository, label an issue with openhands or add a message starting with @openhands. OpenHands will:
  1. 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.
  2. Open a pull request if it determines that the issue has been successfully resolved.
  3. 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
The @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