Skip to content

docs: added integrations docs #1120

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Jun 3, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 63 additions & 0 deletions docs/capabilities/capabilities.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
---
title: "Agent Capabilities"
sidebarTitle: "Overview"
icon: "gear"
iconType: "solid"
---

Codegen agents come equipped with versatile tools designed to integrate seamlessly into your development workflow.

## Integrated Tool Suites

Deep integrations with the tools your team already uses:

<CardGroup cols={3}>
<Card title="GitHub" icon="github" href="/integrations/github">
Create and manage pull requests, automated code reviews, run CI/CD
workflows, sync repository changes.
</Card>
<Card title="Linear" icon="file-lines" href="/integrations/linear">
Create and update issues automatically, track development progress, link
code changes to tickets.
</Card>
<Card title="Slack" icon="slack" href="/integrations/slack">
Chat directly in channels, get real-time notifications, share code snippets
and updates.
</Card>
<Card title="Notion" icon="books" href="/integrations/notion">
Access workspace documentation, update pages and databases, sync development
information.
</Card>
<Card title="Figma" icon="figma" href="/integrations/figma">
Access design specifications, extract design assets, convert designs to
code.
</Card>
<Card title="CircleCI" icon="circle-play" href="/integrations/circleci">
View broken checks, analyze build logs, automatically fix failing PRs and
wake up on failures.
</Card>
<Card title="PostgreSQL" icon="postgres" href="/integrations/postgres">
Execute SQL queries directly, analyze database schemas, generate data
insights.
</Card>
</CardGroup>

## Core Features

Fundamental capabilities for comprehensive development support:

<CardGroup cols={2}>
<Card title="Code Execution Sandbox" icon="box" href="/sandboxes/overview">
Safely run code, install dependencies, and test changes in an isolated
environment.
</Card>
<Card title="Web Search" icon="globe" href="/integrations/web-search">
Access up-to-date information, research libraries, find documentation
online.
</Card>
</CardGroup>

<Note>
These capabilities allow Codegen agents to handle complex tasks across
multiple systems, just like a human developer.
</Note>
67 changes: 67 additions & 0 deletions docs/capabilities/wake-up.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
---
title: "Wake Up & Auto-Fix"
sidebarTitle: "Wake Up"
icon: "bell"
---

When your GitHub checks fail, Codegen automatically wakes up to analyze the failures and fix your PR. This intelligent system monitors CI status and proactively resolves issues without manual intervention.

<Tip>Codegen will try to fix broken checks 3x before "tapping out"</Tip>

## How Wake Up Works

Codegen continuously monitors your pull requests and automatically responds to check failures:

- **Automatic Detection:** Monitors GitHub check runs and CI status in real-time
- **Intelligent Analysis:** Analyzes build logs, test failures, and error messages to understand root causes
- **Targeted Fixes:** Generates specific code changes to resolve the identified issues
- **Persistent Retry:** Will attempt to fix issues up to 3 times per PR

## What Triggers Wake Up

Wake up activates when:

- **CI Checks Fail:** Any GitHub check run reports a failure status
- **Build Errors:** Compilation, linting, or build process failures
- **Test Failures:** Unit tests, integration tests, or automated test suites fail
- **Code Quality Issues:** Static analysis tools report violations or warnings

## The Auto-Fix Process

When Codegen wakes up to fix a failing PR, it follows this process:

1. **Detect Failure:** Monitor check status and identify when builds break
2. **Analyze Logs:** Grep through CI logs to understand specific failure points
3. **Generate Solution:** Create targeted code changes to resolve identified issues
4. **Apply Fix:** Automatically commit fixes to the same PR branch
5. **Re-validate:** Monitor the new check run to ensure the fix was successful

## Retry Logic

Codegen implements intelligent retry behavior:

- **Up to 3 attempts** per PR to resolve failing checks
- **Progressive analysis** - each retry incorporates learnings from previous attempts
- **Failure escalation** - if 3 attempts fail, the issue is flagged for human review

## GitHub Integration

The wake-up system integrates deeply with GitHub:

- **Check Run Annotations:** Creates detailed feedback with line-specific suggestions
- **PR Comments:** Adds contextual suggestions and explanations
- **Auto-Fix Actions:** Provides one-click fix buttons in the GitHub UI
- **Status Updates:** Real-time updates on fix progress and results

<Note>
Wake up only activates for repositories where Codegen has write access and the
feature is enabled. It respects your repository permissions and team
workflows.
</Note>

## Benefits

- **Reduced Context Switching:** No need to manually investigate and fix CI failures
- **Faster Iteration:** PRs get fixed automatically, keeping development velocity high
- **Learning from Failures:** Each fix improves Codegen's understanding of your codebase
- **24/7 Monitoring:** Works around the clock to keep your PRs in good shape
23 changes: 12 additions & 11 deletions docs/docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,23 +14,29 @@
"tab": "Documentation",
"groups": [
{
"group": "Introduction",
"group": "Overview",
"pages": [
"introduction/overview",
"introduction/capabilities",
"introduction/api",
"introduction/prompting",
"introduction/community",
"introduction/about",
"introduction/faq"
]
},
{
"group": "Capabilities",
"pages": ["capabilities/capabilities", "capabilities/wake-up"]
},
{
"group": "Integrations",
"pages": [
"integrations/github",
"integrations/slack",
"integrations/linear",
"integrations/github",
"integrations/notion",
"integrations/figma",
"integrations/circleci",
"integrations/web-search",
"integrations/postgres"
]
Expand All @@ -40,20 +46,15 @@
"pages": [
"sandboxes/overview",
"sandboxes/setup-commands",
"sandboxes/base-image",
"sandboxes/editor",
"sandboxes/environment-variables",
"sandboxes/secrets",
"sandboxes/editor",
"sandboxes/web-preview"
]
},
{
"group": "Settings",
"pages": [
"settings/agent-permissions",
"settings/organization-rules",
"settings/repo-rules",
"settings/model-configuration"
]
"pages": ["settings/repo-rules", "settings/model-configuration"]
}
]
},
Expand Down
72 changes: 72 additions & 0 deletions docs/integrations/circleci.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
---
title: "CircleCI Integration"
sidebarTitle: "CircleCI"
icon: "circle-play"
---

Monitor and automatically fix failing CI checks with CircleCI integration. Codegen views check status, analyzes build logs, and automatically fixes issues when PRs fail. When Codegen creates a PR and checks fail, it will automatically wake up to investigate the logs and push fixes.

<Warning>
CircleCI is currently available for enterprise customers. See
[codegen.com/billing](https://codegen.com/billing) for more
</Warning>

## Capabilities

The CircleCI integration enables intelligent check monitoring and automatic issue resolution:

- **View broken checks and failures** - Monitor CI check status and identify specific failure points
- **Analyze build logs and error messages** - Grep through logs to understand root causes of failures
- **Automatically fix failing PRs** - Push corrective changes when checks fail on Codegen-created PRs
- **Wake up on check failures** - Automatically trigger when CI checks fail to investigate and resolve issues

## Permissions

The Codegen CircleCI integration requires the following permissions:

- **Read project information and settings** - Access pipeline configurations and project details
- **View build history and logs** - Monitor pipeline execution and analyze failure logs
- **Read test results and artifacts** - Access build outputs, test reports, and error details
- **Access check status and details** - Monitor CI check results and failure information

<Note>
Codegen operates in read-only mode for CircleCI - it monitors and analyzes but
does not trigger builds or modify CI configurations.
</Note>

## How Agents Use CircleCI

Agents leverage the CircleCI integration to:

- **Monitor Check Status:** Continuously watch for CI check failures on pull requests
- **Analyze Failure Logs:** Grep through build logs to identify specific errors, test failures, or build issues
- **Auto-Fix Issues:** When Codegen creates a PR and checks fail, it automatically investigates and pushes fixes
- **Prevent Broken Merges:** Ensure code quality by resolving CI failures before merge

## Automatic Wake-Up Behavior

When Codegen creates a pull request and CircleCI checks fail, Codegen will automatically:

1. **Detect the failure** - Monitor check status and identify when builds break
2. **Analyze the logs** - Grep through CircleCI logs to understand the specific failure
3. **Generate fixes** - Create targeted code changes to resolve the identified issues
4. **Push updates** - Automatically commit fixes to the same PR branch

This ensures that Codegen-created PRs maintain high quality and don't introduce breaking changes to your codebase.

## Installation

Connect your CircleCI account to Codegen to enable automatic check monitoring and issue resolution.

<Card
title="Connect CircleCI Account"
icon="circle-play"
href="https://codegen.sh/integrations"
>
Authorize Codegen to view your CircleCI check results and build logs.
</Card>

<Note>
Ensure the agent has access to the specific CircleCI projects and
organizations you want it to monitor.
</Note>{" "}
55 changes: 55 additions & 0 deletions docs/integrations/figma.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
title: "Figma Integration"
sidebarTitle: "Figma"
icon: "figma"
---

AI is one of the most valuable collaborators for front-end modifications, UI updates, messaging, and crafting the aesthetic of what you're building. Codegen can now do serious work on both implementation and contributing to your design documentation, bridging the gap between design and code seamlessly.

## Capabilities

The Figma integration enables seamless design-to-code workflows:

- **Access design specifications** - Read design files, components, and detailed specifications
- **Extract design assets** - Pull images, icons, and visual elements for implementation
- **Convert designs to code** - Transform design mockups into functional frontend code
- **Sync design changes** - Stay updated with design iterations and modifications

## Permissions

The Codegen Figma integration requires the following permissions:

- **Read your profile and user information** - Access basic account details for authentication
- **Access file contents, nodes, and editor data** - Read design files and component structures
- **Read file metadata and version history** - Track design changes and version information
- **View file comments and discussions** - Understand design context and feedback
- **Access design variables and tokens** - Use consistent design system values
- **Read published components and styles** - Access shared design system components
- **Access team library content** - Use shared assets and design resources
- **List projects and project files** - Navigate and organize design files

## How Agents Use Figma

Agents leverage the Figma integration to:

- **Analyze Designs:** Examine design files to understand layout, styling, and component structure
- **Generate Code:** Convert Figma designs into HTML, CSS, React components, or other frontend code
- **Extract Assets:** Pull icons, images, and other visual assets needed for implementation
- **Maintain Design Systems:** Ensure code implementation follows design system guidelines and tokens

## Installation

Connect your Figma account to Codegen to enable design-to-code workflows.

<Card
title="Connect Figma Account"
icon="figma"
href="https://codegen.sh/integrations/figma"
>
Authorize Codegen to access your Figma files and design resources.
</Card>

<Note>
The Figma integration requires feature flag access. Contact your team
administrator to enable this integration.
</Note>{" "}
23 changes: 19 additions & 4 deletions docs/integrations/github.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,29 @@ sidebarTitle: "GitHub"
icon: "github"
---

Connect Codegen to your GitHub repositories to enable agents to read code, create branches, commit changes, open pull requests, comment on issues, and more.
GitHub is how Codegen accesses your repository contents and performs all git interactions. Codegen can create PRs from requests or issues, help resolve merge conflicts, conduct code reviews, search through your codebase, and handle the full spectrum of agentic coding workflows—everything flows through GitHub.

## Capabilities

Our GitHub integration grants Codegen agents both read and write access, allowing them to function like a member of your development team:
The GitHub integration provides comprehensive development workflow capabilities:

- **Read Access:** Clone repositories, read file contents, inspect branches, view issues and PRs.
- **Write Access:** Create branches, push commits, open/update pull requests, comment on PRs and issues, assign reviewers.
- **Create and manage pull requests** - Generate, update, and manage PRs with detailed descriptions and context
- **Automated code reviews and feedback** - Provide intelligent code analysis and suggestions
- **Run checks and CI/CD workflows** - Execute automated testing and deployment processes
- **Sync repository changes** - Keep repositories up-to-date and coordinate between branches

## Permissions

The Codegen GitHub integration requires the following permissions to function as a full development team member:

- **Read and write repository contents** - Access code, files, and repository structure
- **Create and manage pull requests** - Generate, update, and merge pull requests
- **Write status checks and CI/CD results** - Report on automated testing and deployment status
- **Read and write issues and comments** - Interact with project issues and provide updates
- **Read repository metadata and settings** - Access repository configuration and settings
- **Read and write GitHub Actions workflows** - Manage automated workflows and CI/CD pipelines
- **Read organization projects and members** - Access team structure and project organization
- **Manage webhooks for real-time updates** - Enable real-time synchronization and notifications

## How Agents Use GitHub

Expand Down
Loading
Loading