GitHub
CoDev Code integrates with your GitHub workflow. Mention /codev in your comment, and CoDev Code will execute tasks within your GitHub Actions runner.
Features
- Triage issues: Ask CoDev Code to look into an issue and explain it to you.
- Fix and implement: Ask CoDev Code to fix an issue or implement a feature. And it will work in a new branch and submits a PR with all the changes.
- Secure: CoDev Code runs inside your GitHub's runners.
Installation
Run the following command in a project that is in a GitHub repo:
codev github installThis will walk you through creating the workflow file and setting up secrets.
Manual Setup
Or you can set it up manually. CoDev Code runs in your workflow as the public
codev-code npm package — install it in a step and invoke the codev github run
command. There's no third-party action to depend on.
-
Add the workflow
Add the following workflow file to
.github/workflows/codev.ymlin your repo. Make sure to set the appropriateMODELand required API keys inenv..github/workflows/codev.yml name: codev on: issue_comment: types: [created] pull_request_review_comment: types: [created] jobs: codev: if: contains(github.event.comment.body, '/codev') runs-on: ubuntu-latest permissions: contents: write issues: write pull-requests: write steps: - name: Checkout repository uses: actions/checkout@v6 with: fetch-depth: 1 persist-credentials: false - name: Install CoDev Code run: npm install -g codev-code - name: Run CoDev Code run: codev github run env: ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }} GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} MODEL: anthropic/claude-sonnet-4-20250514CoDev Code authenticates with the workflow's built-in
GITHUB_TOKENby default, so no GitHub App install is needed. Commits, comments, and pull requests appear as coming fromgithub-actions[bot]. -
Store the API keys in secrets
In your organization or project settings, expand Secrets and variables on the left and select Actions. And add the required API keys.
Pinning the version
npm install -g codev-code installs the latest release on every run. To pin a
version, or to avoid re-downloading the package each time, install a specific
version and cache it.
- name: Cache CoDev Code
uses: actions/cache@v4
with:
path: ~/.codev-code
key: codev-${{ runner.os }}-${{ runner.arch }}-1.18.3
- name: Install CoDev Code
run: |
npm install --prefix "$HOME/.codev-code" codev-code@1.18.3
echo "$HOME/.codev-code/node_modules/.bin" >> $GITHUB_PATHConfiguration
CoDev Code is configured through the env block of the codev github run step.
-
MODEL: The model to use with CoDev Code. Takes the format ofprovider/model. This is required. -
AGENT: The agent to use. Must be a primary agent. Falls back todefault_agentfrom config or"build"if not found. -
SHARE: Whether to share the CoDev Code session. Defaults to false; sharing publishes the session to upstream's share service. -
PROMPT: Optional custom prompt to override the default behavior. Use this to customize how CoDev Code processes requests. -
MENTIONS: Comma-separated list of trigger phrases (case-insensitive). Defaults to/codev. -
VARIANT: Model variant for provider-specific reasoning effort, e.g.high,max, orminimal. -
USE_GITHUB_TOKEN: Whether to authenticate with the workflow'sGITHUB_TOKEN. Defaults to true. Make sure to grant the required permissions in your workflow:permissions: contents: write pull-requests: write issues: write
The API keys for your provider go in the same env block, read from
secrets.
Supported Events
CoDev Code can be triggered by the following GitHub events:
| Event Type | Triggered By | Details |
|---|---|---|
issue_comment | Comment on an issue or PR | Mention /codev in your comment. CoDev Code reads context and can create branches, open PRs, or reply. |
pull_request_review_comment | Comment on specific code lines in a PR | Mention /codev while reviewing code. CoDev Code receives file path, line numbers, and diff context. |
issues | Issue opened or edited | Automatically trigger CoDev Code when issues are created or modified. Requires PROMPT. |
pull_request | PR opened or updated | Automatically trigger CoDev Code when PRs are opened, synchronized, or reopened. Useful for automated reviews. |
schedule | Cron-based schedule | Run CoDev Code on a schedule. Requires PROMPT. Output goes to logs and PRs (no issue to comment on). |
workflow_dispatch | Manual trigger from GitHub UI | Trigger CoDev Code on demand via Actions tab. Requires PROMPT. Output goes to logs and PRs. |
Schedule Example
Run CoDev Code on a schedule to perform automated tasks:
name: Scheduled CoDev Code Task
on:
schedule:
- cron: "0 9 * * 1" # Every Monday at 9am UTC
jobs:
codev:
runs-on: ubuntu-latest
permissions:
contents: write
pull-requests: write
issues: write
steps:
- name: Checkout repository
uses: actions/checkout@v6
with:
persist-credentials: false
- name: Install CoDev Code
run: npm install -g codev-code
- name: Run CoDev Code
run: codev github run
env:
ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
MODEL: anthropic/claude-sonnet-4-20250514
PROMPT: |
Review the codebase for any TODO comments and create a summary.
If you find issues worth addressing, open an issue to track them.For scheduled events, PROMPT is required since there's no comment to extract instructions from. Scheduled workflows run without a user context to permission-check, so the workflow must grant contents: write and pull-requests: write if you expect CoDev Code to create branches or PRs.
Pull Request Example
Automatically review PRs when they are opened or updated:
name: codev-review
on:
pull_request:
types: [opened, synchronize, reopened, ready_for_review]
jobs:
review:
runs-on: ubuntu-latest
permissions:
contents: read
pull-requests: write
issues: write
steps:
- uses: actions/checkout@v6
with:
persist-credentials: false
- run: npm install -g codev-code
- run: codev github run
env:
ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
MODEL: anthropic/claude-sonnet-4-20250514
PROMPT: |
Review this pull request:
- Check for code quality issues
- Look for potential bugs
- Suggest improvementsFor pull_request events, if no PROMPT is set, CoDev Code defaults to reviewing the pull request.
Issues Triage Example
Automatically triage new issues. This example filters to accounts older than 30 days to reduce spam:
name: Issue Triage
on:
issues:
types: [opened]
jobs:
triage:
runs-on: ubuntu-latest
permissions:
contents: write
pull-requests: write
issues: write
steps:
- name: Check account age
id: check
uses: actions/github-script@v7
with:
script: |
const user = await github.rest.users.getByUsername({
username: context.payload.issue.user.login
});
const created = new Date(user.data.created_at);
const days = (Date.now() - created) / (1000 * 60 * 60 * 24);
return days >= 30;
result-encoding: string
- uses: actions/checkout@v6
if: steps.check.outputs.result == 'true'
with:
persist-credentials: false
- run: npm install -g codev-code
if: steps.check.outputs.result == 'true'
- run: codev github run
if: steps.check.outputs.result == 'true'
env:
ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
MODEL: anthropic/claude-sonnet-4-20250514
PROMPT: |
Review this issue. If there's a clear fix or relevant docs:
- Provide documentation links
- Add error handling guidance for code examples
Otherwise, do not comment.For issues events, PROMPT is required since there's no comment to extract instructions from.
Custom prompts
Override the default prompt to customize CoDev Code's behavior for your workflow.
- run: codev github run
env:
ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
MODEL: anthropic/claude-sonnet-4-5
PROMPT: |
Review this pull request:
- Check for code quality issues
- Look for potential bugs
- Suggest improvementsThis is useful for enforcing specific review criteria, coding standards, or focus areas relevant to your project.
Examples
Here are some examples of how you can use CoDev Code in GitHub.
-
Explain an issue
Add this comment in a GitHub issue.
/codev explain this issueCoDev Code will read the entire thread, including all comments, and reply with a clear explanation.
-
Fix an issue
In a GitHub issue, say:
/codev fix thisAnd CoDev Code will create a new branch, implement the changes, and open a PR with the changes.
-
Review PRs and make changes
Leave the following comment on a GitHub PR.
Delete the attachment from S3 when the note is removed /codevCoDev Code will implement the requested change and commit it to the same PR.
-
Review specific code lines
Leave a comment directly on code lines in the PR's "Files" tab. CoDev Code automatically detects the file, line numbers, and diff context to provide precise responses.
[Comment on specific lines in Files tab] /codev add error handling hereWhen commenting on specific lines, CoDev Code receives:
- The exact file being reviewed
- The specific lines of code
- The surrounding diff context
- Line number information
This allows for more targeted requests without needing to specify file paths or line numbers manually.