Skip to content

Commit 00eeb30

Browse files
committed
.
1 parent c19c64e commit 00eeb30

File tree

7 files changed

+270
-51
lines changed

7 files changed

+270
-51
lines changed

docs/docs.json

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,19 +27,21 @@
2727
"group": "Capabilities",
2828
"pages": [
2929
"capabilities/capabilities",
30-
"introduction/api",
31-
"introduction/cli",
3230
"capabilities/checks-autofixer",
3331
"capabilities/pr-review",
34-
"capabilities/analytics"
32+
"capabilities/analytics",
33+
"introduction/cli",
34+
"introduction/sdk"
3535
]
3636
},
3737
{
3838
"group": "Settings",
3939
"pages": [
4040
"settings/settings",
4141
"settings/repo-rules",
42-
"settings/model-configuration"
42+
"settings/model-configuration",
43+
"settings/agent-behavior",
44+
"settings/agent-permissions"
4345
]
4446
},
4547
{

docs/integrations/slack.mdx

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,11 @@ icon: "slack"
66

77
Connect Codegen to your Slack workspace to enable seamless communication between agents and your team.
88

9-
<img src="/images/slack.png" className="rounded-lg" />
9+
<video
10+
controls
11+
src="https://res.cloudinary.com/dbikr6pew/video/upload/v1757886194/slack-happy-path_yjtx1c.mp4"
12+
className="w-full aspect-[3456/2160] rounded-sm"
13+
/>
1014

1115
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.
1216

@@ -85,15 +89,18 @@ Codegen only responds when tagged or messaged directly. Use these approaches to
8589
The Codegen Slack integration requires the following permissions to function effectively:
8690

8791
### Core Messaging Permissions
92+
8893
- **View messages that mention @codegen** - To respond to direct mentions and requests
8994
- **Read message history in public and private channels** - To understand context and conversation flow
9095
- **Read direct messages and group chats** (`mpim:read`) - To enable private conversations with the agent in group DMs and multi-person direct messages
9196
- **Send messages** - To communicate responses and provide updates
9297

9398
### Enhanced Communication Features
99+
94100
- **View and react with emojis** - To acknowledge messages and provide feedback through reactions
95101

96102
### User and Workspace Access
103+
97104
- **View workspace members and email addresses** (`users:read.email`) - Used to map Slack user accounts to Codegen accounts for proper authentication and permission management. This ensures that when a user interacts with Codegen via Slack, their actions are properly attributed to their Codegen account and repository permissions
98105
- **Access shared files and attachments** - To review and work with shared content like code snippets, images, and documents
99106
- **Access basic channel information** - To operate appropriately within different channel contexts
Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
---
2-
title: "Codegen SDK"
3-
sidebarTitle: "API"
4-
icon: "bolt"
5-
iconType: "solid"
2+
title: "Python SDK"
3+
sidebarTitle: "Python SDK"
4+
icon: "python"
65
---
76

87
The [Codegen SDK](https://github.com/codegen-sh/codegen-sdk) enables developers to programmatically interact with [Codegen](https://codegen.com) SWE agents via API.

docs/sandboxes/overview.mdx

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,5 +29,9 @@ Agents utilize sandboxes for a variety of tasks:
2929
Sandboxes are typically configured per-agent run or defined within your Codegen settings. You often don't need to manage them directly, but advanced configurations might allow specifying Docker images or environment variables.
3030

3131
<Note>
32-
Sandboxes maintain file system persistence between agent interactions within the same context. For example, when continuing a conversation across different Slack messages or Linear comments, the sandbox state is preserved, allowing agents to seamlessly continue their work without losing context or having to reinstall dependencies.
32+
Sandboxes maintain file system persistence between agent interactions within
33+
the same context. For example, when continuing a conversation across different
34+
Slack messages or Linear comments, the sandbox state is preserved, allowing
35+
agents to seamlessly continue their work without losing context or having to
36+
reinstall dependencies.
3337
</Note>{" "}

docs/settings/agent-behavior.mdx

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
---
2+
title: "Agent Behavior"
3+
sidebarTitle: "Agent Behavior"
4+
icon: "robot"
5+
---
6+
7+
Configure the types of behaviors you'd like the AI agent to exhibit. These settings control how agents interact with users and approach code modifications to ensure they align with your team's workflow preferences.
8+
9+
## Available Behaviors
10+
11+
### Propose Plan
12+
13+
Control whether the codegen agent should propose a detailed implementation plan to the user before executing **all** code modifications, regardless of size or complexity.
14+
15+
**When enabled:**
16+
17+
- Agents will present a structured plan showing each implementation step
18+
- Users can review the proposed approach before any code changes are made
19+
- Plans include confidence levels, relevant files, and detailed descriptions
20+
- Provides transparency into the agent's decision-making process
21+
22+
**When disabled:**
23+
24+
- Agents proceed directly with code modifications
25+
- Faster execution for straightforward tasks
26+
- Users can still request plans explicitly when needed
27+
28+
<Tip>
29+
Enable this setting if you prefer to review and approve implementation
30+
approaches before code changes are made, especially for critical or complex
31+
repositories.
32+
</Tip>
33+
34+
### Require Explicit GitHub Mentions
35+
36+
Control whether the codegen agent should only respond to GitHub comments that explicitly mention `@codegen` or `@codegen-sh`.
37+
38+
**When enabled:**
39+
40+
- Agent only responds to comments containing explicit mentions
41+
- Provides precise control over when agents activate
42+
- Reduces unwanted agent responses on general discussions
43+
- Recommended for busy repositories with frequent comments
44+
45+
**When disabled:**
46+
47+
- Agent may respond to relevant comments without explicit mentions
48+
- More proactive agent engagement
49+
- Convenient for smaller teams with focused discussions
50+
51+
<Warning>
52+
In busy repositories, disabling explicit mentions may result in agents
53+
responding to unintended comments. Consider your team's communication patterns
54+
when configuring this setting.
55+
</Warning>
56+
57+
## Configuration
58+
59+
These behavior settings are configured at the organization level and apply to all repositories within your organization. Individual repository settings may override some behaviors where supported.
60+
61+
Access your agent behavior settings at:
62+
63+
<Card
64+
title="Configure Agent Behavior"
65+
icon="robot"
66+
href="https://codegen.com/settings/behavior"
67+
>
68+
Customize how agents interact with your team and approach code modifications.
69+
</Card>
70+
71+
## Best Practices
72+
73+
**For New Teams:**
74+
75+
- Start with "Propose Plan" enabled to understand how agents approach problems
76+
- Use explicit GitHub mentions initially to control agent activation
77+
- Gradually adjust settings as your team becomes comfortable with agent behavior
78+
79+
**For Experienced Teams:**
80+
81+
- Disable "Propose Plan" for routine tasks to increase velocity
82+
- Consider allowing non-explicit mentions in trusted repositories
83+
- Customize settings based on repository criticality and team preferences
84+
85+
**For Large Organizations:**
86+
87+
- Enable explicit mentions to prevent noise in high-traffic repositories
88+
- Use "Propose Plan" for production or critical infrastructure repositories
89+
- Consider different settings for different types of repositories
90+
91+
<Note>
92+
Agent behavior settings help ensure that AI assistance integrates smoothly
93+
with your existing development workflows and team communication patterns.
94+
</Note>
Lines changed: 124 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,76 +1,159 @@
11
---
22
title: "Agent Permissions"
33
sidebarTitle: "Agent Permissions"
4-
icon: "user-shield"
4+
icon: "shield-check"
55
---
66

7-
Agent Permissions allow you to configure what actions the AI agent is allowed to perform across your organization. These settings provide fine-grained control over the agent's capabilities, ensuring it operates within your team's preferred workflows and security boundaries.
7+
Configure what actions the AI agent is allowed to perform across your organization. These permission settings provide fine-grained control over agent capabilities to ensure they operate within your security and workflow requirements.
88

9-
## Accessing Agent Permissions
9+
## Available Permissions
1010

11-
Agent Permission settings are applied globally for your entire organization. You can access and modify these settings by navigating to:
11+
### Enable PR Creation
1212

13-
[**codegen.com/settings/permissions**](https://codegen.com/settings/permissions)
13+
Control whether the codegen agent is able to create pull requests in your repositories in response to user requests.
1414

15-
<Frame caption="Agent Permissions UI at codegen.com/settings/permissions">
16-
<img src="/images/agent-permissions.png" alt="Agent Permissions Configuration" />
17-
</Frame>
15+
**When enabled:**
1816

19-
## Available Permission Settings
17+
- Agents can create new pull requests with code changes
18+
- PRs include detailed descriptions and context
19+
- Automatic linking to related issues and discussions
20+
- Supports your standard code review workflow
2021

21-
### Enable PR Creation
22+
**When disabled:**
23+
24+
- Agents can still analyze code and provide suggestions
25+
- Code changes are proposed but not committed
26+
- Manual PR creation required for implementing changes
27+
- Useful for read-only or advisory agent roles
2228

23-
**Control whether the codegen agent is able to create pull requests in your repositories in response to user requests.**
29+
### Enable Rules Detection
2430

25-
When enabled, the agent can automatically create pull requests when implementing features, fixing bugs, or making other code changes. When disabled, the agent will make changes locally but won't create PRs, requiring manual PR creation.
31+
Allow the agent to automatically detect and apply rules from various rule files in your repositories.
2632

27-
- **Default**: Enabled
28-
- **Use Case**: Disable if you prefer manual PR creation or have strict PR workflows
33+
**Supported rule file formats:**
2934

30-
### Enable Rules Detection
35+
- `.cursorrules` - Cursor AI editor rules
36+
- `.cursor/rules/*.mdc` - Structured rule files in Cursor directory
37+
- `.windsurfrules` - Windsurf AI editor rules
38+
- `CLAUDE.md` - Claude-specific instructions
39+
- `AGENTS.md` - General agent instructions
40+
- `AGENT.md` - Agent-specific rules
41+
42+
**When enabled:**
43+
44+
- Agents automatically discover and apply repository-specific rules
45+
- Rules are version-controlled alongside your code
46+
- Consistent behavior across team members and environments
47+
- Supports existing AI editor workflows
48+
49+
**When disabled:**
50+
51+
- Only manually configured repository rules are applied
52+
- No automatic file-based rule detection
53+
- Simpler rule management through web interface only
54+
55+
### Enforce Organization-wide Signed Commits
56+
57+
When enabled, **ALL** repositories in this organization will be required to use signed commits via GitHub's API. Individual repositories cannot override this security policy.
58+
59+
**Security benefits:**
60+
61+
- Cryptographic verification of commit authenticity
62+
- Enhanced audit trail for code changes
63+
- Compliance with security policies requiring commit signing
64+
- Protection against commit impersonation
65+
66+
**Important considerations:**
67+
68+
- This is an organization-wide enforcement policy
69+
- Individual repositories cannot disable this requirement
70+
- Ensures consistent security posture across all projects
71+
- May require additional setup for team members' GPG keys
72+
73+
<Warning>
74+
Enabling organization-wide signed commits affects all repositories and cannot
75+
be overridden at the repository level. Ensure your team is prepared for this
76+
requirement before enabling.
77+
</Warning>
78+
79+
## Configuration
80+
81+
Agent permissions are configured at the organization level and provide security boundaries for all agent operations within your organization.
82+
83+
Access your agent permissions at:
84+
85+
<Card
86+
title="Configure Agent Permissions"
87+
icon="shield-check"
88+
href="https://codegen.com/settings/permissions"
89+
>
90+
Control what actions agents are allowed to perform in your organization.
91+
</Card>
92+
93+
## Permission Combinations
94+
95+
### Development Teams
3196

32-
**Allow the agent to automatically detect and apply rules from .cursorrules and .windsurfrules files in your repositories.**
97+
```
98+
✅ Enable PR Creation
99+
✅ Enable Rules Detection
100+
❌ Enforce Signed Commits (unless required)
101+
```
33102

34-
This setting enables the agent to automatically discover and follow coding standards, style guides, and other rules defined in your repository's configuration files.
103+
Standard setup for most development teams wanting full agent capabilities.
35104

36-
- **Default**: Enabled
37-
- **Use Case**: Disable if you want to manually control rule application or don't use these rule files
105+
### Security-Conscious Organizations
38106

39-
### Enable Linear Self-Assign
107+
```
108+
✅ Enable PR Creation
109+
✅ Enable Rules Detection
110+
✅ Enforce Signed Commits
111+
```
40112

41-
**Allow the codegen agent to self-assign Linear issues, enabling it to spin off other agents.**
113+
Maximum security with full agent functionality and commit verification.
42114

43-
When enabled, the agent can assign itself to Linear issues and potentially delegate work to other agent instances for parallel processing.
115+
### Read-Only Advisory Mode
44116

45-
- **Default**: Enabled
46-
- **Use Case**: Disable if you prefer manual issue assignment or want to limit agent autonomy
117+
```
118+
❌ Enable PR Creation
119+
✅ Enable Rules Detection
120+
❌ Enforce Signed Commits
121+
```
47122

48-
### Enable Linear Auto State Change
123+
Agents provide analysis and suggestions without making direct code changes.
49124

50-
**When enabled, the agent will automatically move Linear issues to 'Started' state when self-assigning them.**
125+
### Compliance-First Approach
51126

52-
This setting automates the workflow by updating issue status when the agent begins work, providing better visibility into what the agent is actively working on.
127+
```
128+
✅ Enable PR Creation
129+
❌ Enable Rules Detection
130+
✅ Enforce Signed Commits
131+
```
53132

54-
- **Default**: Disabled
55-
- **Use Case**: Enable for automatic issue tracking and improved project visibility
133+
Strict control with manual rule management and required commit signing.
56134

57135
## Best Practices
58136

59-
### Security Considerations
137+
**Start Conservative:**
60138

61-
- Review permission settings regularly to ensure they align with your team's security policies
62-
- Consider disabling PR creation in production environments if you require manual review processes
63-
- Monitor agent activity when enabling self-assignment features
139+
- Begin with limited permissions and expand as trust builds
140+
- Enable rules detection to leverage existing team practices
141+
- Consider PR creation permissions based on repository criticality
64142

65-
### Workflow Integration
143+
**Security Considerations:**
66144

67-
- Enable Linear Auto State Change if your team relies on Linear for project tracking
68-
- Coordinate permission settings with your existing CI/CD and review processes
69-
- Consider your team's preferred level of automation when configuring these settings
145+
- Enable signed commits for organizations with compliance requirements
146+
- Review agent-created PRs before merging, especially initially
147+
- Monitor agent activity through analytics and audit logs
70148

71-
## Related Documentation
149+
**Team Alignment:**
72150

73-
- [Repository Rules](/settings/repo-rules) - Configure repository-specific behavior
74-
- [Linear Integration](/integrations/linear) - Set up Linear workspace integration
75-
- [Model Configuration](/settings/model-configuration) - Configure LLM settings
151+
- Ensure team understands which permissions are enabled
152+
- Provide training on rule file formats if using rules detection
153+
- Establish clear processes for agent-created PRs
76154

155+
<Note>
156+
Permission settings provide essential guardrails for agent operations while
157+
maintaining the flexibility to customize based on your organization's security
158+
and workflow requirements.
159+
</Note>

0 commit comments

Comments
 (0)