openAgent

1# opencode GitHub Action
2 
3A GitHub Action that integrates [opencode](https://opencode.ai) directly into your GitHub workflow.
4 
5Mention `/opencode` in your comment, and opencode will execute tasks within your GitHub Actions runner.
6 
7## Features
8 
9#### Explain an issue
10 
11Leave the following comment on a GitHub issue. `opencode` will read the entire thread, including all comments, and reply with a clear explanation.
12 
13```
14/opencode explain this issue
15```
16 
17#### Fix an issue
18 
19Leave the following comment on a GitHub issue. opencode will create a new branch, implement the changes, and open a PR with the changes.
20 
21```
22/opencode fix this
23```
24 
25#### Review PRs and make changes
26 
27Leave the following comment on a GitHub PR. opencode will implement the requested change and commit it to the same PR.
28 
29```
30Delete the attachment from S3 when the note is removed /oc
31```
32 
33#### Review specific code lines
34 
35Leave a comment directly on code lines in the PR's "Files" tab. opencode will automatically detect the file, line numbers, and diff context to provide precise responses.
36 
37```
38[Comment on specific lines in Files tab]
39/oc add error handling here
40```
41 
42When commenting on specific lines, opencode receives:
43 
44- The exact file being reviewed
45- The specific lines of code
46- The surrounding diff context
47- Line number information
48 
49This allows for more targeted requests without needing to specify file paths or line numbers manually.
50 
51## Installation
52 
53Run the following command in the terminal from your GitHub repo:
54 
55```bash
56opencode github install
57```
58 
59This will walk you through installing the GitHub app, creating the workflow, and setting up secrets.
60 
61### Manual Setup
62 
631. Install the GitHub app https://github.com/apps/opencode-agent. Make sure it is installed on the target repository.
642. Add the following workflow file to `.github/workflows/opencode.yml` in your repo. Set the appropriate `model` and required API keys in `env`.
65 
66   ```yml
67   name: opencode
68 
69   on:
70     issue_comment:
71       types: [created]
72     pull_request_review_comment:
73       types: [created]
74 
75   jobs:
76     opencode:
77       if: |
78         contains(github.event.comment.body, '/oc') ||
79         contains(github.event.comment.body, '/opencode')
80       runs-on: ubuntu-latest
81       permissions:
82         id-token: write
83       steps:
84          - name: Checkout repository
85            uses: actions/checkout@v6
86            with:
87              fetch-depth: 1
88              persist-credentials: false
89 
90          - name: Run opencode
91           uses: anomalyco/opencode/github@latest
92           env:
93             ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
94             GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
95           with:
96             model: anthropic/claude-sonnet-4-20250514
97             use_github_token: true
98   ```
99 
1003. Store the API keys in secrets. In your organization or project **settings**, expand **Secrets and variables** on the left and select **Actions**. Add the required API keys.
101 
102## Support
103 
104This is an early release. If you encounter issues or have feedback, please create an issue at https://github.com/anomalyco/opencode/issues.
105 
106## Development
107 
108To test locally:
109 
1101. Navigate to a test repo (e.g. `hello-world`):
111 
112   ```bash
113   cd hello-world
114   ```
115 
1162. Run:
117 
118   ```bash
119   MODEL=anthropic/claude-sonnet-4-20250514 \
120     ANTHROPIC_API_KEY=sk-ant-api03-1234567890 \
121     GITHUB_RUN_ID=dummy \
122     MOCK_TOKEN=github_pat_1234567890 \
123     MOCK_EVENT='{"eventName":"issue_comment",...}' \
124     bun /path/to/opencode/github/index.ts
125   ```
126 
127   - `MODEL`: The model used by opencode. Same as the `MODEL` defined in the GitHub workflow.
128   - `ANTHROPIC_API_KEY`: Your model provider API key. Same as the keys defined in the GitHub workflow.
129   - `GITHUB_RUN_ID`: Dummy value to emulate GitHub action environment.
130   - `MOCK_TOKEN`: A GitHub personal access token. This token is used to verify you have `admin` or `write` access to the test repo. Generate a token [here](https://github.com/settings/personal-access-tokens).
131   - `MOCK_EVENT`: Mock GitHub event payload (see templates below).
132   - `/path/to/opencode`: Path to your cloned opencode repo. `bun /path/to/opencode/github/index.ts` runs your local version of `opencode`.
133 
134### Issue comment event
135 
136```
137MOCK_EVENT='{"eventName":"issue_comment","repo":{"owner":"sst","repo":"hello-world"},"actor":"fwang","payload":{"issue":{"number":4},"comment":{"id":1,"body":"hey opencode, summarize thread"}}}'
138```
139 
140Replace:
141 
142- `"owner":"sst"` with repo owner
143- `"repo":"hello-world"` with repo name
144- `"actor":"fwang"` with the GitHub username of commenter
145- `"number":4` with the GitHub issue id
146- `"body":"hey opencode, summarize thread"` with comment body
147 
148### Issue comment with image attachment.
149 
150```
151MOCK_EVENT='{"eventName":"issue_comment","repo":{"owner":"sst","repo":"hello-world"},"actor":"fwang","payload":{"issue":{"number":4},"comment":{"id":1,"body":"hey opencode, what is in my image ![Image](https://github.com/user-attachments/assets/xxxxxxxx)"}}}'
152```
153 
154Replace the image URL `https://github.com/user-attachments/assets/xxxxxxxx` with a valid GitHub attachment (you can generate one by commenting with an image in any issue).
155 
156### PR comment event
157 
158```
159MOCK_EVENT='{"eventName":"issue_comment","repo":{"owner":"sst","repo":"hello-world"},"actor":"fwang","payload":{"issue":{"number":4,"pull_request":{}},"comment":{"id":1,"body":"hey opencode, summarize thread"}}}'
160```
161 
162### PR review comment event
163 
164```
165MOCK_EVENT='{"eventName":"pull_request_review_comment","repo":{"owner":"sst","repo":"hello-world"},"actor":"fwang","payload":{"pull_request":{"number":7},"comment":{"id":1,"body":"hey opencode, add error handling","path":"src/components/Button.tsx","diff_hunk":"@@ -45,8 +45,11 @@\n- const handleClick = () => {\n-   console.log('clicked')\n+ const handleClick = useCallback(() => {\n+   console.log('clicked')\n+   doSomething()\n+ }, [doSomething])","line":47,"original_line":45,"position":10,"commit_id":"abc123","original_commit_id":"def456"}}}'
166```
167