diff --git a/docs/capabilities/capabilities.mdx b/docs/capabilities/capabilities.mdx new file mode 100644 index 000000000..5ae7d28b2 --- /dev/null +++ b/docs/capabilities/capabilities.mdx @@ -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: + + + + Create and manage pull requests, automated code reviews, run CI/CD + workflows, sync repository changes. + + + Create and update issues automatically, track development progress, link + code changes to tickets. + + + Chat directly in channels, get real-time notifications, share code snippets + and updates. + + + Access workspace documentation, update pages and databases, sync development + information. + + + Access design specifications, extract design assets, convert designs to + code. + + + View broken checks, analyze build logs, automatically fix failing PRs and + wake up on failures. + + + Execute SQL queries directly, analyze database schemas, generate data + insights. + + + +## Core Features + +Fundamental capabilities for comprehensive development support: + + + + Safely run code, install dependencies, and test changes in an isolated + environment. + + + Access up-to-date information, research libraries, find documentation + online. + + + + + These capabilities allow Codegen agents to handle complex tasks across + multiple systems, just like a human developer. + diff --git a/docs/capabilities/wake-up.mdx b/docs/capabilities/wake-up.mdx new file mode 100644 index 000000000..a542d7594 --- /dev/null +++ b/docs/capabilities/wake-up.mdx @@ -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. + +Codegen will try to fix broken checks 3x before "tapping out" + +## 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 + + + Wake up only activates for repositories where Codegen has write access and the + feature is enabled. It respects your repository permissions and team + workflows. + + +## 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 diff --git a/docs/docs.json b/docs/docs.json index eb6c36ac7..bcb781e65 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -14,10 +14,9 @@ "tab": "Documentation", "groups": [ { - "group": "Introduction", + "group": "Overview", "pages": [ "introduction/overview", - "introduction/capabilities", "introduction/api", "introduction/prompting", "introduction/community", @@ -25,12 +24,19 @@ "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" ] @@ -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"] } ] }, diff --git a/docs/integrations/circleci.mdx b/docs/integrations/circleci.mdx new file mode 100644 index 000000000..03cf94259 --- /dev/null +++ b/docs/integrations/circleci.mdx @@ -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. + + + CircleCI is currently available for enterprise customers. See + [codegen.com/billing](https://codegen.com/billing) for more + + +## 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 + + + Codegen operates in read-only mode for CircleCI - it monitors and analyzes but + does not trigger builds or modify CI configurations. + + +## 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. + + + Authorize Codegen to view your CircleCI check results and build logs. + + + + Ensure the agent has access to the specific CircleCI projects and + organizations you want it to monitor. +{" "} diff --git a/docs/integrations/figma.mdx b/docs/integrations/figma.mdx new file mode 100644 index 000000000..38f355c7d --- /dev/null +++ b/docs/integrations/figma.mdx @@ -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. + + + Authorize Codegen to access your Figma files and design resources. + + + + The Figma integration requires feature flag access. Contact your team + administrator to enable this integration. +{" "} diff --git a/docs/integrations/github.mdx b/docs/integrations/github.mdx index 07fd98ace..03c14e23b 100644 --- a/docs/integrations/github.mdx +++ b/docs/integrations/github.mdx @@ -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 diff --git a/docs/integrations/linear.mdx b/docs/integrations/linear.mdx index c53fd04ea..d192b9a21 100644 --- a/docs/integrations/linear.mdx +++ b/docs/integrations/linear.mdx @@ -1,10 +1,10 @@ --- title: "Linear Integration" sidebarTitle: "Linear" -icon: "book" +icon: "file-lines" --- -Integrate Codegen with your Linear workspace to allow agents to interact with issues, manage projects, and keep your team updated. +Linear is designed to orchestrate teams of humans and agents working together. It's the most efficient way to track progress and scale teams of agents to tackle large, complex tasks. Codegen can take a first pass at virtually any issue, breaking down work and making meaningful progress before human review. We recommend letting Codegen handle the initial exploration and implementation of most tasks. @@ -14,25 +14,39 @@ Connect your Linear workspace to Codegen to enable agent interactions. Authorize Codegen to access your Linear workspace via the API settings. - API access allows agents to interact with issues and projects according - to your permissions in Linear. + API access allows agents to interact with issues and projects according to + your permissions in Linear. ## Capabilities -The Linear integration provides read and write access, enabling agents to manage tasks effectively: +The Linear integration provides comprehensive project management capabilities: -- **Read Access:** Fetch issue details, read comments, view project status, list team members. -- **Write Access:** Update issue status (e.g., to "In Progress", "Done"), add comments, link GitHub PRs to issues, create new issues, assign tasks. +- **Create and update issues automatically** - Generate new tasks and update existing ones based on development needs +- **Track development progress** - Monitor and report on the status of ongoing work +- **Link code changes to tickets** - Connect GitHub pull requests and commits directly to Linear issues +- **Sync status updates** - Keep issue statuses current as work progresses through different stages - **Multi Agent Systems:** Create sub-issues and assign child agents to break down complex tasks into manageable pieces. [Learn more](#multi-agent-systems). +## Permissions + +The Codegen Linear integration requires the following permissions: + +- **Create issues for your workspace** - Generate new tasks and tickets as needed +- **Create issue comments and discussions** - Provide updates, ask questions, and facilitate collaboration +- **Read access to your workspace data** - Access existing issues, projects, and team information +- **Write access to update issues and projects** - Modify issue status, assignees, and project details +- **Assign issues and projects to teams** - Route work to appropriate team members +- **Mention app in issues and documents** - Enable notifications and cross-references +- **Receive realtime updates about workspace changes** - Stay synchronized with workspace activity + ## How Agents Use Linear Agents use the Linear integration to streamline project management: @@ -48,7 +62,7 @@ Agents use the Linear integration to streamline project management: Once you've enabled linear self-assign in the settings [page](https://www.chadcode.sh/settings/permissions), a codegen agent, that has been assigned to a linear issue (or has been tagged in one), can spawn child agents by creating sub-issues and assigning itself to those sub-issues. For each sub-issue that codegen assigns to itself a child agent will be spawned and tasked with completing the sub-issue. Once the child agents are -finished with their tasks they will notify their parent by sending it a message. The parent will then incorporate the child's work into its own as appropriate. +finished with their tasks they will notify their parent by sending it a message. The parent will then incorporate the child's work into its own as appropriate. ### Best Practices diff --git a/docs/integrations/notion.mdx b/docs/integrations/notion.mdx new file mode 100644 index 000000000..bcb53ad89 --- /dev/null +++ b/docs/integrations/notion.mdx @@ -0,0 +1,54 @@ +--- +title: "Notion Integration" +sidebarTitle: "Notion" +icon: "books" +--- + +Notion is your team's knowledge base, and now Codegen can tap into it too. Share PRDs, specs, and documentation with Codegen for technical feedback and implementation. A common workflow: pass a PRD to Codegen and it will provide technical insights, comment directly on the document, and then go implement the features described. + +## Capabilities + +The Notion integration enables seamless access to your team's knowledge base: + +- **Access workspace documentation** - Read and analyze existing documentation, specs, and project requirements +- **Update pages and databases** - Modify content, add comments, and keep documentation current +- **Sync development information** - Bridge the gap between planning documents and code implementation +- **Generate knowledge base content** - Create new documentation based on development work and insights + +## Permissions + +The Codegen Notion integration requires the following permissions: + +- **Read workspace content and documents** - Access existing pages, databases, and documentation +- **Update existing pages and documents** - Modify content and add comments for collaboration +- **Create new pages and content** - Generate new documentation and project materials +- **Access user information and emails** - Understand team structure and collaboration context +- **Read database entries and properties** - Access structured data and project information +- **Update database entries and values** - Modify project data and status information +- **Create new databases and structures** - Establish new organizational systems as needed + +## How Agents Use Notion + +Agents leverage the Notion integration to: + +- **Analyze Requirements:** Read PRDs and technical specifications to understand project scope and requirements +- **Provide Technical Feedback:** Comment on documents with implementation insights and technical considerations +- **Update Documentation:** Keep project documentation current as development progresses +- **Bridge Planning and Code:** Connect high-level planning documents with actual code implementation + +## Installation + +Connect your Notion workspace to Codegen to enable agent interactions with your knowledge base. + + + Authorize Codegen to access your Notion workspace and documentation. + + + + The Notion integration requires feature flag access. Contact your team + administrator to enable this integration. +{" "} diff --git a/docs/integrations/slack.mdx b/docs/integrations/slack.mdx index 2fae18620..4450f1a93 100644 --- a/docs/integrations/slack.mdx +++ b/docs/integrations/slack.mdx @@ -8,16 +8,19 @@ Connect Codegen to your Slack workspace to enable seamless communication between +Slack is the most fluid way to communicate with Codegen. Simply tag @codegen in any channel to collaborate directly and give it tasks that leverage all your other integrations. As an agent, Codegen can seamlessly work across platforms—from GitHub to Linear to your databases—all initiated from Slack. We recommend Slack as the lowest barrier entry point for all users. + ## Installation -To use this integration, follow the installation and configuration steps below. +To use this integration, follow the installation and configuration steps below. - Create a Codegen account and visit Integrations > Slack to connect your Slack workspace. + Create a Codegen account and visit Integrations > Slack to connect your Slack + workspace. @@ -27,17 +30,14 @@ To use this integration, follow the installation and configuration steps below. After installation, proceed to the Configuration Instructions below to finish setup and begin using Codegen in your Slack workspace. -## Capabilities & Functions +## Capabilities -Codegen functions as a full-fledged software engineer that you can interact with directly through Slack. When responding to messages in Slack, Codegen can: +The Slack integration enables seamless collaboration with Codegen directly within your workspace: -- **Perform Research:** Search the web for information, documentation, or solutions to problems. -- **Manage Issues:** Triage and update issues in Linear or GitHub based on your requests. -- **Develop Code:** Make code changes, improvements, or implement new features across your repositories. -- **Create Pull Requests:** Draft, review, and submit PRs with detailed descriptions and context. -- **Provide Updates:** Keep you informed about progress, blockers, or completion of tasks. -- **Request Clarification:** Ask for additional context or guidance when needed to complete a task effectively. -- **Share Results:** Deliver summaries, documentation, links to PRs, or explanations of changes made. +- **Chat with Codegen directly in channels** - Interact naturally through @mentions and direct messages +- **Get real-time notifications** - Stay updated on task progress and completion +- **Share code snippets and updates** - Collaborate on code changes and development tasks +- **Collaborate on development tasks** - Coordinate work across your entire development workflow All of these capabilities are accessible through natural language interactions in your Slack workspace, allowing your team to leverage Codegen's assistance without context switching between different platforms. @@ -46,16 +46,20 @@ All of these capabilities are accessible through natural language interactions i After installing the integration from the Slack Marketplace, configure the bot by inviting it to relevant channels and setting up triggers so Codegen knows when and how to respond. ### Channel Setup + - **Invite the Codegen bot**: Type `/invite @codegen` in any channel where you want Codegen to participate. - (Optional) **Create a dedicated channel**: Some Codegen users find creating a channel like `#codegen` helpful for general agent interactions and to encourage experimentation. ## What Triggers Slack Messages from Codegen + These triggers kick off new Codegen requests: + - **Direct mentions**: Type `@codegen` followed by your request in any channel where the bot is present. - **Thread replies**: Tag `@codegen` in threads to continue the conversation. - **Direct messages**: Send a DM to the Codegen bot for private conversations. In addition, Codegen will send messages to Slack when: + - It starts work on a request you made - It receives an additional message while working on a request - It completes a task, code change, or research request @@ -65,6 +69,7 @@ In addition, Codegen will send messages to Slack when: Codegen only responds when tagged or messaged directly. Use these approaches to ensure your request reaches it: - **Direct Messages:** + - Responds to any DM sent to the Codegen integration for Slack - Has visibility into previous messages in the conversation (not just threaded replies) - This provides a more natural conversation experience as many users don't thread messages in DMs @@ -75,6 +80,19 @@ Codegen only responds when tagged or messaged directly. Use these approaches to - Sending subsequent messages within a thread routes to the same agent (tag `@codegen` to trigger) - New messages to `@codegen` in an active thread will interrupt the agent if it's currently working +## Permissions + +The Codegen Slack integration requires the following permissions to function effectively: + +- **View messages that mention @codegen** - To respond to direct mentions and requests +- **Read message history in public and private channels** - To understand context and conversation flow +- **Send messages and customize appearance** - To communicate and provide updates +- **View and react with emojis** - To acknowledge messages and provide feedback +- **Access shared files and attachments** - To review and work with shared content +- **Read direct messages and group chats** - To enable private conversations with the agent +- **View workspace members and email addresses** - To understand team structure and routing +- **Access basic channel information** - To operate appropriately within different channel contexts + ## Data Privacy and Security **Message Content Handling:** @@ -91,4 +109,4 @@ Codegen's actions on connected repositories are governed by the permissions of t - Use direct language when asking Codegen for help (e.g., "Add pagination to the results view"). - Mention Codegen early in the message so it is triggered promptly. -- Use threads for ongoing conversations with Codegen so it has access to previous context. \ No newline at end of file +- Use threads for ongoing conversations with Codegen so it has access to previous context. diff --git a/docs/integrations/web-search.mdx b/docs/integrations/web-search.mdx index 66466dc5d..3a7e97ea3 100644 --- a/docs/integrations/web-search.mdx +++ b/docs/integrations/web-search.mdx @@ -28,7 +28,7 @@ Agents utilize web search capabilities to: Web search is automatically available to agents when needed, powered by exa's advanced search capabilities. - + Discover how exa powers our web search capabilities with state-of-the-art search technology. diff --git a/docs/introduction/api.mdx b/docs/introduction/api.mdx index 09e50afa1..27cc8ed7a 100644 --- a/docs/introduction/api.mdx +++ b/docs/introduction/api.mdx @@ -1,7 +1,7 @@ --- title: "Codegen SDK" sidebarTitle: "API" -icon: "code" +icon: "bolt" iconType: "solid" --- diff --git a/docs/introduction/capabilities.mdx b/docs/introduction/capabilities.mdx deleted file mode 100644 index d53b2a8de..000000000 --- a/docs/introduction/capabilities.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: "Agent Capabilities" -sidebarTitle: "Capabilities" -icon: "gear" -iconType: "solid" ---- - -Codegen agents come equipped with a versatile set of tools and capabilities designed to seamlessly integrate into your development workflow and automate a wide range of tasks. - -## Integrated Tool Suites - -Our agents have deep integrations with the tools your team already uses: - - - - Manage repositories, review PRs, comment on issues, create branches, commit - code, and more. - - - Update ticket statuses, add comments, link PRs, create new issues based on - findings, and manage project boards. - - - Send notifications, ask for clarification, report progress, and interact - directly with your team. - - - -## Core Features - -Beyond specific tool integrations, Codegen agents possess fundamental capabilities: - - - - Safely run code, install dependencies, and test changes in an isolated - environment. - - - Access up-to-date information, research libraries, find documentation, and - learn about new technologies. - - - - - These capabilities allow Codegen agents to handle complex tasks that require - interacting with multiple systems, just like a human developer. - diff --git a/docs/introduction/overview.mdx b/docs/introduction/overview.mdx index 082faca6d..c7868c636 100644 --- a/docs/introduction/overview.mdx +++ b/docs/introduction/overview.mdx @@ -9,7 +9,10 @@ Codegen provides intelligent AI agents designed to seamlessly integrate into you Think of it as an AI coworker that can understand and solve coding challenges, access your codebase instantly, and interact directly with your development tools. -Focus on higher-level tasks and leverage Codegen agents to do the low-level labor of software engineering. + + Focus on higher-level tasks and leverage Codegen agents to do the low-level + labor of software engineering. + ## What Can Codegen Agents Do? @@ -30,7 +33,7 @@ Codegen agents come equipped with a versatile set of tools and capabilities: Update ticket statuses, add comments, link PRs to issues, and create new @@ -77,7 +80,7 @@ Integrating Codegen into your workflow is designed to be quick and easy: Connect your Linear workspace to enable agent interactions with your issues. diff --git a/docs/sandboxes/editor.mdx b/docs/sandboxes/editor.mdx index 5a8a6c163..883f62fa1 100644 --- a/docs/sandboxes/editor.mdx +++ b/docs/sandboxes/editor.mdx @@ -1,7 +1,7 @@ --- title: "Remote Editor (VSCode)" sidebarTitle: "Editor" -icon: "pencil" +icon: "laptop-code" --- Codegen provides access to a remote VSCode editor instance that is directly connected to your active sandbox environment. This powerful feature allows for real-time interaction with the agent's workspace, offering capabilities for live debugging, manual intervention, and detailed progress monitoring. diff --git a/docs/sandboxes/secrets.mdx b/docs/sandboxes/secrets.mdx new file mode 100644 index 000000000..9ad0b0f55 --- /dev/null +++ b/docs/sandboxes/secrets.mdx @@ -0,0 +1,41 @@ +--- +title: "Repository Secrets" +sidebarTitle: "Secrets" +icon: "key" +--- + +Manage environment variables and secrets for your repository. These are securely injected into the agent's sandbox environment during code execution. + + + Only use staging credentials and non-production secrets. Never store + production API keys, database passwords, or sensitive credentials. + + +## How Secrets Work + +Repository secrets are environment variables that get automatically injected into the sandbox when agents execute code: + +- **Secure Storage:** Secrets are encrypted and stored securely per repository +- **Sandbox Injection:** Automatically available as environment variables during agent execution +- **Development Support:** Enable agents to run dev servers, connect to staging databases, and test integrations + +## Common Use Cases + +- **Development Server Credentials:** API keys for staging services and development APIs +- **Database Connections:** Connection strings for staging/test databases +- **Third-Party Integrations:** Non-production tokens for services like Stripe test mode, staging analytics +- **Build Configuration:** Environment-specific build variables and feature flags + +## Managing Secrets + +Add secrets through your repository settings: + +1. Navigate to your repository settings +2. Go to the Secrets tab +3. Add key-value pairs for your environment variables +4. Secrets are immediately available to agents in the sandbox + + + Agents can access these secrets when running code, starting development + servers, or executing tests that require environment configuration. +{" "}