# Compass File Lister

Compass file lister is an automation that lists rids (resource identifiers) of resources in a given **input folder** into a Code repository. When run, a new pull request is opened on the **output repository** where it will either create the file for the first time, or override the existing one. The generated file will be stored by default at the following path: `compass-lister/rids.json`. Review [Create a connected flow](../create-a-connected-flow/index.md) for a step-by-step guide.

## Configuration options

* You can override the base path in the output repository by setting the `generated_file_path` in the configuration block. If you set it to `transforms-python/generated`, the output will be written to `transforms-python/generated/rids.json`.

* The resulting PR can be allowed to merge automatically if `merge_when_ready` is set to `true` in the configuration block. See your output repository settings to review the conditions that allow the PR to be merged.

### Configuration example

```
{
  "generated_file_path": "transforms-python/generated",
  "merge_when_ready": true
}
```