Shellway

Home / Prompts / Code

Explain a codebase

Get a plain-English map of an unfamiliar project and where to start.

CodeInstant

The prompt

Look at the project in ~/code/my-app. Explain what it does, how the folders are organised, the main entry points, how to run it locally and the three files I should read first.

How to use it

  1. Make sure Shellway is connected in ChatGPT, Claude or Cursor.
  2. Paste the prompt and change the folder names or paths to match your computer.
  3. Review the plan your AI shows before you confirm any changes.

Related prompts