Use an ellipsis.yaml file to take Ellipsis from a “kinda cool” tool to a “game changer” for your team.

By default, Ellipsis will use a set of default configurations when reviewing code, writing code, and more. However, you can override these defaults by adding an ellipsis.yaml file to the root of your repository.

Initially, we suggest adding an about and ignore section to help Ellipsis understand your repository. This will help Ellipsis leave smarter review comments and write better code.

Here’s an example ellipsis.yaml file:

version: 1.3
about:
  - "This code is a monorepo for an application that allows users to track their workouts"
  - "The frontend is a React app, and located in the `frontend/` directory. It gets deployed to Vercel using the `deploy_vercel.sh` script"
  - "The backend uses a Supabase database and has access to AWS S3 for file storage"
  - "For job processing we use a product called Hatchet, which has a python SDK that the backend uses"
  - "We are in the middle of a migration from AWS to GCP for the backend"
ignore:
  - old_README.md   # ignore this file
  - archive/        # ignore everything in the `archive/` directory
  - data/*.csv      # ignore all .csv files in the `data/` directory
  - aws/**/*.ts      # ignore all .tsx files in the `aws/` directory or it's subdirectories

Configuration Options

Choose a specific feature and scroll to the “Configure” section to learn about the available configuration options.