Skip to content
Newquantumcoderxyz v2 is now available

GitHub

Use quantumcoderxyz in GitHub issues and pull-requests.

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


Features

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

Installation

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

Terminal window
quantumcoderxyz 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. Install the GitHub app

    Head over to github.com/apps/quantumcoderxyz-agent. Make sure it’s installed on the target repository.

  2. Add the workflow

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

    .github/workflows/quantumcoderxyz.yml
    name: quantumcoderxyz
    on:
    issue_comment:
    types: [created]
    pull_request_review_comment:
    types: [created]
    jobs:
    quantumcoderxyz:
    if: |
    contains(github.event.comment.body, '/oc') ||
    contains(github.event.comment.body, '/quantumcoderxyz')
    runs-on: ubuntu-latest
    permissions:
    id-token: write
    contents: read
    steps:
    - name: Checkout repository
    uses: actions/checkout@v6
    with:
    fetch-depth: 1
    persist-credentials: false
    - name: Run quantumcoderxyz
    uses: anomalyco/quantumcoderxyz/github@latest
    env:
    ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
    with:
    model: anthropic/claude-sonnet-5-5

    contents: read lets checkout read private repositories. id-token: write lets quantumcoderxyz exchange an OIDC token for a GitHub App token, which supplies the permissions used to comment and push changes.

  3. 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 quantumcoderxyz. Takes the format of provider/model. This is required.

  • agent: The agent to use. Must be a primary agent. Falls back to default_agent from config or "build" if not found.

  • prompt: Optional custom prompt to override the default behavior. Use this to customize how quantumcoderxyz processes requests.

  • mentions: Comma-separated list of trigger phrases, case-insensitive. Defaults to /quantumcoderxyz,/oc.

  • variant: Model variant for provider-specific reasoning effort, for example high, max, or minimal.

  • oidc_base_url: Base URL for the OIDC token exchange API. Only needed when running a custom GitHub App install. Defaults to https://api.quantumcoder.xyz.

  • use_github_token: Set to true to use a caller-provided GITHUB_TOKEN instead of exchanging an OIDC token for an quantumcoderxyz App installation token. Defaults to false.

    Use this mode to run without installing the quantumcoderxyz GitHub App. Pass the token through env and grant the permissions required by your workflow:

    permissions:
    contents: write
    pull-requests: write
    issues: write
    steps:
    - uses: actions/checkout@v6
    - run: |
    git config --global user.name "github-actions[bot]"
    git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
    - uses: anomalyco/quantumcoderxyz/github@latest
    env:
    ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
    with:
    model: anthropic/claude-sonnet-5-5
    use_github_token: true

    id-token: write is not required in this mode because OIDC exchange is skipped. Keep checkout’s default persist-credentials: true for Git authentication, and configure a Git user name and email if quantumcoderxyz will commit changes. quantumcoderxyz only configures these in OIDC mode.

    To use a personal access token or another GitHub App token, store it as a secret and pass that secret as both GITHUB_TOKEN and checkout’s token input.


Supported Events

quantumcoderxyz can be triggered by the following GitHub events:

Event Type Triggered By Details
issue_comment Comment on an issue or PR Mention /quantumcoderxyz or /oc in your comment. quantumcoderxyz reads context and can create branches, open PRs, or reply.
pull_request_review_comment Comment on specific code lines in a PR Mention /quantumcoderxyz or /oc while reviewing code. quantumcoderxyz receives file path, line numbers, and diff context.
issues Issue opened or edited Automatically trigger quantumcoderxyz when issues are created or modified. Requires prompt input.
pull_request PR opened or updated Automatically trigger quantumcoderxyz when PRs are opened, synchronized, or reopened. Useful for automated reviews.
schedule Cron-based schedule Run quantumcoderxyz on a schedule. Requires prompt input. Output goes to logs and PRs (no issue to comment on).
workflow_dispatch Manual trigger from GitHub UI Trigger quantumcoderxyz on demand via Actions tab. Requires prompt input. Output goes to logs and PRs.

Schedule Example

Run quantumcoderxyz on a schedule to perform automated tasks:

.github/workflows/quantumcoderxyz-scheduled.yml
name: Scheduled quantumcoderxyz Task
on:
schedule:
- cron: "0 9 * * 1" # Every Monday at 9am UTC
jobs:
quantumcoderxyz:
runs-on: ubuntu-latest
permissions:
id-token: write
contents: read
steps:
- name: Checkout repository
uses: actions/checkout@v6
with:
persist-credentials: false
- name: Run quantumcoderxyz
uses: anomalyco/quantumcoderxyz/github@latest
env:
ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
with:
model: anthropic/claude-sonnet-5-5
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, the prompt input is required since there’s no comment to extract instructions from. Scheduled workflows run without a user context to permission-check. With use_github_token: true, grant contents: write and pull-requests: write to create branches or PRs, and use the checkout and Git setup shown in Configuration. The default OIDC mode uses the quantumcoderxyz GitHub App’s permissions instead.


Pull Request Example

Automatically review PRs when they are opened or updated:

.github/workflows/quantumcoderxyz-review.yml
name: quantumcoderxyz-review
on:
pull_request:
types: [opened, synchronize, reopened, ready_for_review]
jobs:
review:
runs-on: ubuntu-latest
permissions:
contents: read
pull-requests: read
issues: write
steps:
- uses: actions/checkout@v6
- uses: anomalyco/quantumcoderxyz/github@latest
env:
ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
model: anthropic/claude-sonnet-5-5
use_github_token: true
prompt: |
Review this pull request:
- Check for code quality issues
- Look for potential bugs
- Suggest improvements

For pull_request events, if no prompt is provided, quantumcoderxyz defaults to reviewing the pull request.

issues: write lets quantumcoderxyz react to and comment on the PR, since GitHub handles PR comments through the issues API. This example is intended for PRs from branches in the same repository; PRs from forks normally get a read-only GITHUB_TOKEN and no secrets.


Issues Triage Example

Automatically triage new issues. This example filters to accounts older than 30 days to reduce spam:

.github/workflows/quantumcoderxyz-triage.yml
name: Issue Triage
on:
issues:
types: [opened]
jobs:
triage:
runs-on: ubuntu-latest
permissions:
id-token: write
contents: read
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
- uses: anomalyco/quantumcoderxyz/github@latest
if: steps.check.outputs.result == 'true'
env:
ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
with:
model: anthropic/claude-sonnet-5-5
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, the prompt input is required since there’s no comment to extract instructions from.


Custom prompts

Override the default prompt to customize quantumcoderxyz’s behavior for your workflow.

.github/workflows/quantumcoderxyz.yml
- uses: anomalyco/quantumcoderxyz/github@latest
with:
model: anthropic/claude-sonnet-5-5
prompt: |
Review this pull request:
- Check for code quality issues
- Look for potential bugs
- Suggest improvements

This 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 quantumcoderxyz in GitHub.

  • Explain an issue

    Add this comment in a GitHub issue.

    /quantumcoderxyz explain this issue

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

  • Fix an issue

    In a GitHub issue, say:

    /quantumcoderxyz fix this

    And quantumcoderxyz 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

    quantumcoderxyz 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. quantumcoderxyz automatically detects the file, line numbers, and diff context to provide precise responses.

    [Comment on specific lines in Files tab]
    /oc add error handling here

    When commenting on specific lines, quantumcoderxyz 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.