Customize how Optibot reviews code, generates suggestions, and produces summaries for your repository.

Overview

Optibot reads a .optibot file placed at the root of your repository.

This file uses JSON and controls everything from review categories to summaries and dependency analysis.

If the file is missing, Optibot uses default platform settings.

You can also view this configuration inside the product at agents.getoptimal.ai
Dashboard → Documentation → Advanced Configuration.

Example Configuration

{
  "reviews": {
    "auto": true,
    "exclude": ["bugs_prompt"],
    "include": ["security_prompt", "error_handling_prompt"],
    "autoApprove": true,
    "codeSuggestions": true,
    "codeSuggestionsSkipFiles": ["*.md", "docs/*", "vendor/*"],
    "excludedLabels": ["wontfix", "low-priority"],
    "excludedUsers": ["bot-account"]
  },
  "summary": {
    "auto": true,
    "level": "detailed",
    "excludedLabels": ["wontfix", "low-priority"],
    "excludedUsers": ["bot-account"]
  },
  "dependencyBundler": {
    "enabled": true
  },
  "enableCIFixer": true,
  "guidelinesUrl": "docs/guidelines/README.md"
}

Configuration Options

Reviews Configuration

auto

Controls whether Optibot automatically reviews pull requests.
Default: false

exclude

Categories to exclude from review.
Allowed values:

• bugs_prompt

• security_prompt

• error_handling_prompt
  Default: []

include

Categories to explicitly include.
Same allowed values as above.
Default: [] (includes all categories)
Note: include overrides exclude.

autoApprove

Automatically approves PRs that pass all checks.
Default: true

codeSuggestions

Enables AI code suggestions.
Default: true

codeSuggestionsSkipFiles

File patterns excluded from review suggestions.
Examples: ["*.md", "docs/*"]
Default: []

excludedLabels

Labels that prevent a PR from being reviewed.
Example: ["wontfix", "low-priority"]
Default: []

excludedUsers

Usernames excluded from automatic review.
Example: ["user1", "bot-account"]
Default: []

Summary Configuration

auto

Controls automatic PR summary generation.
Default: true

level

Detail level of generated summaries.
Allowed values: basic, detailed, comprehensive
Default: detailed

• basic — high-level description

• detailed — components, analysis, reasoning

• comprehensive — file-by-file analysis

excludedLabels

Exclude PRs with specific labels from summaries.
Example: ["wontfix", "low-priority"]
Default: []

excludedUsers

Exclude summaries for PRs authored by specific users.
Example: ["user1", "bot-account"]
Default: []

Dependency Management

dependencyBundler.enabled

Enables dependency analysis and optimization suggestions.
Default: true

CI Fixer Configuration

enableCIFixer

Allows Optibot to diagnose failed CI checks and open fix PRs.
Default: false

Guidelines URL Configuration

guidelinesUrl

Optional path or URL pointing to your engineering guidelines.
Supports both relative and full GitHub URLs.
Default: null

Best Practices

• Keep PRs small and focused — Optibot performs best on well-scoped changes.

• Use labels to categorize PRs and help Optibot understand intent.

• Address Optibot suggestions before merging.

• Enable CI Fixer to reduce time spent debugging failing pipelines.

• Use include for strict policies and codeSuggestionsSkipFiles for noisy directories.