Custom Instructions

Repomix allows you to provide custom instructions that will be included in the output file. This can be useful for adding context or specific guidelines for AI systems processing the repository.

Usage

To include a custom instruction, create a markdown file (e.g., repomix-instruction.md) in the root of your repository. Then, specify the path to this file in your repomix.config.json:

{
  "output": {
    "instructionFilePath": "repomix-instruction.md"
  }
}

The content of this file will be included in the output under the "Instruction" section.

Example

# Repository Instructions

This repository contains the source code for the Repomix tool. Please follow these guidelines when analyzing the code:

1. Focus on the core functionality in the `src/core` directory.
2. Pay special attention to the security checks in `src/core/security`.
3. Ignore any files in the `tests` directory.

This will result in the following section in the output:

<instruction>
# Repository Instructions

This repository contains the source code for the Repomix tool. Please follow these guidelines when analyzing the code:

1. Focus on the core functionality in the `src/core` directory.
2. Pay special attention to the security checks in `src/core/security`.
3. Ignore any files in the `tests` directory.
</instruction>