Understand an unfamiliar repository

Open your project#

Run mirr in the project folder. A Git repository is a project folder whose changes are tracked by version control. You can also ask about files in folders that do not use Git.

Ask about the overall structure#

If you do not know where to begin, enter:

Explain what this project does.
Find its entry point, main folders, tests, and run instructions.
Include the relevant file paths with each explanation. Do not modify files.

Mirr Code reads the project files and explains the structure. Asking for paths lets you open the relevant code in your editor while reading the explanation.

Follow a feature#

You can ask directly about a feature instead of starting with the whole project.

Explain what happens after someone presses the login button.
Connect the screen, server request, and code that displays the result.

If you already have a file in mind, select it with @. See Context and files.

Continue into a task#

In the same conversation, you can request a change such as “Add a helpful message when login fails.” If you only need an explanation, there is no need to request an edit.

See Implement a change to build a feature, or Debug a failure to investigate an error.