Installation

Multiple ways to integrate DevTeam.ai into your workflow - choose what works best for your team.

1. GitHub Actions (Recommended)

The fastest way to get started. Add AI agents to your repository with workflow files.

Best for: Teams already using GitHub Actions, quick setup, zero infrastructure

Prerequisites

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

Setup Steps

Step 1: Add API Key to Secrets

Go to your repository Settings → Secrets and variables → Actions
Click "New repository secret"
Name: DEVTEAM_API_KEY
Value: Paste your API key from devteam.ai
Click "Add secret"

Step 2: Add Workflow Files

Create these files in .github/workflows/:

Review Agent Workflow

yaml

# .github/workflows/devteam-review.yml
name: DevTeam Review Agent

on:
  pull_request:
    types: [opened, synchronize, reopened]

jobs:
  review:
    runs-on: ubuntu-latest
    permissions:
      contents: read
      pull-requests: write

    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0

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

Implementation Agent Workflow

yaml

# .github/workflows/devteam-implement.yml
name: DevTeam Implementation Agent

on:
  issues:
    types: [labeled]

jobs:
  implement:
    if: contains(github.event.label.name, 'ready-to-implement')
    runs-on: ubuntu-latest
    permissions:
      contents: write
      issues: write
      pull-requests: write

    steps:
      - 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 3: Test Your Setup

Review Agent: Create a PR to see automated code review comments
Implementation Agent: Create an issue and add the "ready-to-implement" label

2. CLI Installation

Use the DevTeam CLI for local development and advanced workflows.

Best for: Local testing, advanced automation, custom integrations

Install via npm

bash

npm install -g @devteam/cli

Install via Homebrew (macOS/Linux)

bash

brew tap devteam-ai/tap
brew install devteam

Authenticate

bash

devteam auth login

# Or set API key directly
export DEVTEAM_API_KEY=your_api_key_here

Basic Usage

bash

# Review code changes
devteam review --files src/**/*.ts

# Implement a feature from issue description
devteam implement --issue 123

# Generate tests for a file
devteam test --file src/utils.ts

# Plan a sprint from issues
devteam plan --milestone v2.0

See the CLI Documentation for all available commands.

3. Direct API Integration

Integrate DevTeam.ai into your custom tools via the GraphQL API.

Best for: Custom integrations, internal tools, programmatic access

API Endpoint

text

https://devteam-api.finhub.workers.dev/graphql

Authentication

Include your API key in the Authorization header:

typescript

const response = await fetch('https://devteam-api.finhub.workers.dev/graphql', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer YOUR_API_KEY'
  },
  body: JSON.stringify({
    query: `
      query {
        projects {
          id
          name
          status
        }
      }
    `
  })
});

const data = await response.json();

See the API Documentation for the complete schema reference.

Next Steps

Explore GitHub Actions Workflows

Learn about all available AI agents and their capabilities

API Authentication

Manage API keys, scopes, and rate limits

Troubleshooting Guide

Common issues and solutions