.octopusignore

Quick Start

Create a .octopusignore file at the root of your repository:

# Generated documentation
docs/generated/**

# Test fixtures and snapshots
tests/fixtures/**
**/__snapshots__/**

# Vendor / third-party code
third-party/**
vendor/**

# Large data files
*.csv
*.parquet
*.sql

Syntax

The file uses the same pattern syntax as .gitignore, powered by the ignore npm package.

Lines starting with # are comments. Blank lines are ignored.

How It Works

During Indexing

When Octopus indexes your repository, it checks for a .octopusignore file. Matched files are never chunked or embedded — they won't appear in code search results or be used as review context.

During Review

When reviewing a PR, Octopus filters out diff sections for ignored files. The AI reviewer never sees changes to those files, so it won't comment on them.

Build Artifact Detection

Octopus automatically detects committed build artifacts and dependency folders — even without a .octopusignore file. If your PR includes files from these directories, a critical finding is created:

This automatically triggers REQUEST_CHANGES on GitHub, blocking the PR until the artifacts are removed. This check runs on the raw diff before .octopusignore filtering, so it can't be bypassed.

Common Patterns

# Ignore shared configs
.eslintrc.*
prettier.config.*

# Ignore generated types
**/generated/**
**/*.generated.ts

# Ignore migrations (review manually)
**/migrations/**

# Ignore bundled assets
public/assets/**
dist/**

# Ignore lockfiles (too noisy)
pnpm-lock.yaml
package-lock.json
bun.lock

# Ignore data files
*.csv
*.parquet
*.h5
*.pkl

# Ignore model checkpoints
checkpoints/**
models/**/*.bin

Provider Support

.octopusignore works with both supported providers:

If the file doesn't exist or can't be fetched, Octopus continues normally without any ignore rules.