OpenHands AI Action

A GitHub Action that runs OpenHands AI tasks with customizable prompts and environment variables.

Usage

- name: Run OpenHands Task
  uses: your-org/openhands-action@v1
  with:
    prompt: "your task prompt here"
    llm_api_key: ${{ secrets.LLM_API_KEY }}
    github_token: ${{ secrets.GITHUB_TOKEN }}
    additional_env: |
      {
        "CUSTOM_VAR": "value",
        "ANOTHER_VAR": "another_value"
      }

Inputs

Input	Required	Default	Description
prompt	Yes	-	The prompt/task to execute with OpenHands
llm_model	No	anthropic/claude-3-7-sonnet-20250219	LLM model to use
llm_api_key	Yes	-	API key for the LLM service
github_token	Yes	-	GitHub token with required permissions
log_all_events	No	true	Whether to log all events
runtime_image	No	docker.all-hands.dev/all-hands-ai/runtime:0.32-nikolaik	Runtime container image
openhands_image	No	docker.all-hands.dev/all-hands-ai/openhands:0.32	OpenHands container image
additional_env	No	{}	JSON string of additional environment variables

Environment Variables

The action supports passing additional environment variables through the additional_env input. These variables will be available in the container.

Example:

additional_env: |
  {
    "CUSTOM_VAR": "value",
    "ANOTHER_VAR": "another_value"
  }

Requirements

• Access to the specified Docker images
• Appropriate permissions for Docker operations in GitHub Actions
• Required secrets configured in your repository

License

[Add your license here]

Support

[Add support information here]