https://github.com/mirrajabi/aider-github-action
Run Aider AI assistant in your Github Workflows!
https://github.com/mirrajabi/aider-github-action
Last synced: about 1 month ago
JSON representation
Run Aider AI assistant in your Github Workflows!
- Host: GitHub
- URL: https://github.com/mirrajabi/aider-github-action
- Owner: mirrajabi
- License: apache-2.0
- Created: 2023-12-30T13:14:18.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-08-12T10:43:01.000Z (about 2 months ago)
- Last Synced: 2025-08-12T12:37:58.209Z (about 2 months ago)
- Language: Shell
- Size: 90.8 KB
- Stars: 52
- Watchers: 4
- Forks: 12
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-AI-driven-development - aider-github-action - Run Aider AI assistant in your Github Workflows! (Domain-Specific Tools / Git & Version Control)
README
# Aider GitHub Action
This action runs [Aider](https://github.com/paul-gauthier/aider) in a container given a set of arguments, let's Aider apply changes, then it pushes the changes to the repository on the branch you pass to it.
## Usage
### Using Aider Github Workflows
The easiest and recommended way to use this action is to use the [aider-github-workflows](https://github.com/mirrajabi/aider-github-workflows).
See [Issue to PR workflow](https://github.com/mirrajabi/aider-github-workflows/blob/main/docs/issue-to-pr.md) which is a great place to start.
### Using the action by itself
In your workflow file, add the following step to your job:
```yaml
jobs:
my_job:
steps:
- name: Apply changes with Aider
uses: mirrajabi/aider-github-action@v1.1.0
timeout-minutes: 10 # So that you won't accidentally burn your LLM provider credits!
with:
api_key_env_name: OPENAI_API_KEY
api_key_env_value: ${{ secrets.openai_api_key }}
branch: ${{ fromJson(steps.create_branch.outputs.result).ref }}
model: ${{ inputs.model }}
aider_args: '--yes --message "Do this and that"'
```
#### Action Inputs
When using the action directly, you can pass the following inputs to it:
| Field Name | Description | Required | Type | Default |
|------------------|---------------------------------------------------------------|-----------|---------|--------------------------|
| `aider_args` | Space-delimited args to pass to aider (Example: `"--yes --message 'Make the dashboard sidebar purple'"`) | **true** | string | - |
| `branch` | Branch to run Aider on | **false** | string | main |
| `model` | Model to run Aider with. Find available models on [this page](https://aider.chat/docs/llms.html) | **true** | string | - |
| `api_key_env_name` | "The name of the environment variable. For example, OPENAI_API_KEY, ANTHROPIC_API_KEY, etc. See more info [here](https://aider.chat/docs/llms.html) | **false** | string | - |
| `api_key_env_value` | The API Key to use as the value of the `api_key_env_name` | **false** | string | - |
## Credits
This project uses [Paul Gauthier's Aider](https://github.com/paul-gauthier/aider). It's a great tool, and you should check it out! You can also use it as your local coding assistant.