GitHub

codeflow integrates with your GitHub workflow. Mention /codeflow or /oc in your comment, and codeflow will execute tasks within your GitHub Actions runner.

---

Features

• Triage issues: Ask codeflow to look into an issue and explain it to you.
• Fix and implement: Ask codeflow 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: codeflow runs inside your GitHub’s runners.

---

Installation

Run the following command in a project that is in a GitHub repo:

codeflow github install

This will walk you through installing the GitHub app, creating the workflow, and setting up secrets.

---

Manual Setup

Or you can set it up manually.

1. Add the workflow

   Add the following workflow file to .github/workflows/codeflow.yml in your repo. Make sure to set the appropriate model and required API keys in env.

   .github/workflows/codeflow.yml

   name: codeflow
   
   on:
     issue_comment:
       types: [created]
   
   jobs:
     codeflow:
       if: |
         contains(github.event.comment.body, '/oc') ||
         contains(github.event.comment.body, '/codeflow')
       runs-on: ubuntu-latest
       permissions:
         id-token: write
       steps:
         - name: Checkout repository
           uses: actions/checkout@v4
           with:
             fetch-depth: 1
   
         - name: Run codeflow
           uses: sst/codeflow/github@latest
           env:
             ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
           with:
             model: anthropic/claude-sonnet-4-20250514
             # share: true
             # github_token: xxxx

2. 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.

---

Configuration

• model: The model to use with codeflow. Takes the format of provider/model. This is required.

• share: Whether to share the codeflow session. Defaults to true for public repositories.

• token: Optional GitHub access token for performing operations such as creating comments, commiting changes, and opening pull requests. By default, codeflow uses the installation access token from the codeflow GitHub App, so commits, comments, and pull requests appear as coming from the app.

  Alternatively, you can use the GitHub Action runner’s built-in GITHUB_TOKEN without installing the codeflow GitHub App. Just make sure to grant the required permissions in your workflow:

  permissions:
    id-token: write
    contents: write
    pull-requests: write
    issues: write

  You can also use a personal access tokens(PAT) if preferred.

---

Examples

Here are some examples of how you can use codeflow in GitHub.

• Explain an issue

  Add this comment in a GitHub issue.

  /codeflow explain this issue

  codeflow will read the entire thread, including all comments, and reply with a clear explanation.

• Fix an issue

  In a GitHub issue, say:

  /codeflow fix this

  And codeflow 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 /oc

  codeflow will implement the requested change and commit it to the same PR.