Use this skill to explain the project at the current working directory to the user. This is different from onboarding: the goal is not only to orient the agent, but to produce a clear user-facing explanation.
Scope
Explain:
- what the project appears to do
- who or what it is for
- main technologies and frameworks
- important files and directories
- how the code is organized
- how to run, build, and test it when discoverable
- noteworthy constraints, risks, or unclear areas
Workflow
- Inspect project instructions first.
- Read local
AGENTS.md,.codex/,.agents/, README files, and central docs when present. - Respect project-specific instructions over global assumptions.
- Read local
- Identify project type and stack.
- Check common manifest/config files such as
package.json,pyproject.toml,Cargo.toml,go.mod,platformio.ini,CMakeLists.txt,compose.yaml, and CI workflows.
- Check common manifest/config files such as
- Map structure without over-reading.
- Prefer
rg --filesand shallow directory listings. - Avoid dependency, generated, cache, and build output directories.
- Prefer
- Read representative files.
- Inspect entry points, main modules, routes, commands, hardware targets, or app screens depending on the project.
- Read only what is needed to explain the project accurately.
- Produce a user-facing explanation.
- Keep it concise and concrete.
- Separate confirmed facts from inferences.
- Mention unknowns only when they matter.
- Do not edit files unless the user explicitly asks for documentation changes.
Output
Use this structure when helpful:
- Overview
- Main Stack
- Directory Map
- How It Works
- Run / Build / Test
- Important Files
- Notes and Unknowns
Prefer short sections over long exhaustive analysis. If the user asks for a README-style document, propose a target file and wait for explicit edit approval before creating or modifying files.