Skip to content
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
71 changes: 71 additions & 0 deletions docs/gen/capabilities.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
---
title: "Capabilities"
icon: "gear"
---

Codegen is built on an [open-source library](/introduction/overiew.mdx) for code manipulation.

It combines "tools" for code editing with powerful integrations, including Github, Linear and Slack.

<Tip>
Learn more about our open source [code agent implementation](/docs/tutorials/build-code-agent)
</Tip>

## Communication Tools

- **SlackSendMessageTool**: Allows Codegen to send messages in Slack channels and threads, providing responses to your queries and sharing information with your team.

## GitHub Integration Tools

Codegen includes a comprehensive set of GitHub tools:

- **GithubCheckoutPRTool**: Checks out pull requests to your local environment for review and testing.

- **GithubCreatePRTool**: Creates new pull requests from your current branch, including title, description, and target branch.

- **GithubCreatePRCommentTool**: Adds comments to pull requests for feedback and team communication.

- **GithubCreatePRReviewCommentTool**: Provides inline comments on specific code changes within pull requests.

- **GithubEditPRTool**: Modifies existing pull requests, including updating titles, descriptions, and other metadata.

- **GithubSearchIssuesTool**: Searches for GitHub issues based on various criteria like status, assignee, or labels.

- **GithubViewPRTool**: Retrieves and displays information about specific pull requests.

- **GithubViewPRCheckTool**: Checks the status of CI/CD and other automated checks on pull requests.

- **GithubViewCommitHistoryTool**: Shows the commit history of a repository or specific branch.

- **GithubViewCommitTool**: Displays details about specific commits, including changes made.

## Linear Integration Tools (Optional)

For teams using Linear for project management, Codegen offers:

- **LinearGetIssueTool**: Retrieves details about specific Linear issues.

- **LinearGetIssueCommentsTool**: Fetches comments on Linear issues for context and history.

- **LinearCommentOnIssueTool**: Adds comments to Linear issues for team communication.

- **LinearSearchIssuesTool**: Searches for Linear issues based on various criteria.

- **LinearCreateIssueTool**: Creates new issues in Linear with appropriate metadata.

- **LinearGetTeamsTool**: Retrieves information about teams in your Linear organization.

## How Codegen Uses These Tools

Codegen's AI brain (powered by Claude 3.7 Sonnet) intelligently selects and combines these tools to:

1. Understand your requests through natural language in Slack
2. Determine the most appropriate tools to fulfill your request
3. Execute the necessary actions across GitHub, Linear, and your codebase
4. Provide clear, helpful responses back in Slack

This seamless integration allows you to manage your entire development workflow through simple conversations, without having to switch between different platforms and interfaces.

## Getting Started

Ready to experience the power of Codegen? Check out our [Quickstart Guide](/docs/gen/quickstart) to set up Codegen for your team, and explore [Common Commands](/docs/gen/common-commands) to see how to interact with these tools through natural language.
18 changes: 18 additions & 0 deletions docs/gen/faq.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: "Frequently Asked Questions"
sidebarTitle: "FAQ"
icon: "square-question"
iconType: "solid"
---

<AccordionGroup>
<Accordion title="What model does Codegen use?" icon="code">
Claude 3.7. Our code agent is roughly comparable with Claude Code.
</Accordion>
<Accordion title="Is this free?" icon="scale-balanced">
Yes! For now. Get it while it's hot.
</Accordion>
<Accordion title="Where is my data stored?" icon="database">
Codegen stores this data in their private cloud. We are SOC-2 compliant. [Learn more](/introduction/about)
</Accordion>
</AccordionGroup>
43 changes: 43 additions & 0 deletions docs/gen/introduction.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
title: "Codegen: AI Development Assistant"
sidebarTitle: "Introduction"
icon: "lightbulb"
---

Codegen is an intelligent code agent powered that seamlessly integrates with Slack, Github and Linear.

<Frame caption="Communicate with codegen via Slack">
<img src="/images/codegen-bot-intro.png" />
</Frame>

<Tip>
Explore our [Capabilities](/docs/gen/capabilities) page to learn more about
Codegen's full feature set and available tools!
</Tip>


# Installation

[Log in with GitHub](https://codegen.sh/start) to install Codegen and set up integrations.

<Card title="Get Started" href={"https://codegen.sh/start"} icon="Gear">
Install codegen via OAuth with Github, Slack and Linear
</Card>

# Common Queries

> *Edit repo X so that the user auth flow uses JWT*
Modify the authentication flow in a specified repository to use JSON Web Tokens. This ensures secure and stateless authentication.

> *Show me the recent activity on my repo X*
Display the latest commits, pull requests, and other activities in a specified repository. This helps you stay updated with ongoing changes.

> *Can you figure out why my tests are failing on `main`?*
Analyze the test failures on the main branch to identify potential issues. This assists in maintaining code quality and stability.

> *Can you review my PR?*
Perform a code review on a specified pull request, providing feedback and suggestions. This ensures code quality and adherence to best practices.

> *Do we have any tickets about Y?*
Search for tickets related to a specific topic or issue. This helps in tracking and managing tasks effectively.

Binary file added docs/images/codegen-bot-intro.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading