1. Select the file you actually want to understand
npx @autodocify/autodocs explain src/services/payment.tsRun the command with Node.js 20 or newer and replace the example path with a file in your checkout. A relative path is resolved from your current working directory.
The explanation prints in your terminal without changing the file or generating Markdown. It uses the same source inspection pipeline as project analysis, with the selected file as the focus.
2. Read purpose and operations first
Start with any detected purpose, declarations and operations. Source comments and documentation can describe the author's intended responsibility, but they do not prove that the implementation behaves as described.
Compare the summary with the exported functions, classes and configuration in the file. If the source has little descriptive context, expect a limited explanation rather than a complete account of its business role.
3. Follow imports and local importers
Direct imports show what the module depends on. Local importers show where it may be consumed in the scanned project. These are useful places to continue reading when a function's inputs or responsibilities are unclear.
An imported dependency does not automatically imply a function call or a network request. Recognized SDK calls and storage references are separate evidence. Verify the call site before drawing a conclusion about external effects.
4. Step back to the project when context is missing
npx @autodocify/autodocs explain .A directory explanation provides the wider set of detected routes, models, services and integrations. Use it to check how the selected module fits into the project rather than inferring the architecture from one filename.
If you need to investigate a particular relationship, ask a focused question with ask and follow its source references. Use analyze when the final goal is reviewed Markdown documentation.
5. Account for analysis coverage
JavaScript and TypeScript receive deeper import and call analysis. Other supported syntax can provide declarations and observed references, while unknown text source may receive a generic explanation with limited coverage.
Custom module paths, reflection, generated source, dynamic imports and injected clients can prevent relationships from resolving. A layer diagram is inferred from declarations and dependencies. Use runtime tools to verify actual call order or side effects.