DevTeam.ai
GitHubGet Started

Quick Start Guide

Get DevTeam.ai agents running in your repository in under 5 minutes.

Prerequisites

  • A GitHub repository
  • GitHub Actions enabled
  • DevTeam.ai API key (sign up at devteam.ai)

Step 1: Add Your API Key to GitHub Secrets

Navigate to your repository settings and add your DevTeam.ai API key:

  1. Go to Settings → Secrets and variables → Actions
  2. Click New repository secret
  3. Name: DEVTEAM_API_KEY
  4. Value: Your API key from devteam.ai

Step 2: Add the Review Agent Workflow

Create .github/workflows/devteam-review.yml:

yaml
name: DevTeam Review Agent


on:
  pull_request:
    types: [opened, synchronize]


jobs:
  review:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4


      - name: Run DevTeam Review Agent
        uses: devteam-ai/review-agent@v1
        with:
          api-key: ${{ secrets.DEVTEAM_API_KEY }}
          github-token: ${{ secrets.GITHUB_TOKEN }}

Step 3: Add the Implementation Agent Workflow

Create .github/workflows/devteam-implement.yml:

yaml
name: DevTeam Implementation Agent


on:
  issues:
    types: [labeled]


jobs:
  implement:
    if: contains(github.event.label.name, 'ready-to-implement')
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4


      - name: Run DevTeam Implementation Agent
        uses: devteam-ai/implementation-agent@v1
        with:
          api-key: ${{ secrets.DEVTEAM_API_KEY }}
          github-token: ${{ secrets.GITHUB_TOKEN }}
          issue-number: ${{ github.event.issue.number }}

Step 4: Test It Out

You're all set! Here's how to test your setup:

Test the Review Agent

  1. Create a new branch
  2. Make some code changes
  3. Open a pull request
  4. The Review Agent will automatically comment with code review feedback

Test the Implementation Agent

  1. Create a new issue describing a feature or bug fix
  2. Add the label "ready-to-implement"
  3. The Implementation Agent will create a PR with the implementation

What's Next?

Troubleshooting

Agent didn't run

Check that:

  • Your API key is correctly set in GitHub secrets
  • GitHub Actions is enabled for your repository
  • The workflow file is in .github/workflows/

API rate limits

Free tier includes 5 tasks/month. Upgrade to Starter ($9/mo) for 25 tasks or Pro ($29/mo) for 100 tasks.

Need help?