This guide explains how to use the OpenHands GitHub Action in your own projects.
To use the OpenHands GitHub Action in a repository, you can:
fix-me
label to the issue or leave a comment on the issue starting with@openhands-agent
.The action will automatically trigger and attempt to resolve the issue.
To install the OpenHands GitHub Action in your own repository, followtheREADME for the OpenHands Resolver.
fix-me
label to the issue, or leave a comment starting with@openhands-agent
.fix-me
label to the pull request, or address a specific comment by starting with@openhands-agent
.fix-me
): Requests OpenHands to address theentire issue or pull request.@openhands-agent
): Requests OpenHands to consider only the issue/pull request description andthe specific comment.You can provide custom directions for OpenHands by following theREADME for the resolver.
GitHub resolver will automatically check for validrepository secrets orrepository variables to customize its behavior.The customization options you can set are:
Attribute name | Type | Purpose | Example |
---|---|---|---|
LLM_MODEL | Variable | Set the LLM to use with OpenHands | LLM_MODEL="anthropic/claude-3-5-sonnet-20241022" |
OPENHANDS_MAX_ITER | Variable | Set max limit for agent iterations | OPENHANDS_MAX_ITER=10 |
OPENHANDS_MACRO | Variable | Customize default macro for invoking the resolver | OPENHANDS_MACRO=@resolveit |
OPENHANDS_BASE_CONTAINER_IMAGE | Variable | Custom Sandbox (learn more) | OPENHANDS_BASE_CONTAINER_IMAGE="custom_image" |
TARGET_BRANCH | Variable | Merge to branch other thanmain | TARGET_BRANCH="dev" |
TARGET_RUNNER | Variable | Target runner to execute the agent workflow (default ubuntu-latest) | TARGET_RUNNER="custom-runner" |