跳到主要内容

编程与工程

让 Agent 先读懂仓库再动手

接手陌生项目、或让 agent 第一次进入一个代码库时的开场提示词。

  • Claude Code
  • OpenAI Codex
  • Cursor

完整模板

替换花括号中的占位符后使用

先不要改任何代码。请按下面顺序做一次仓库勘察,然后只输出结论:

1. 技术栈与运行方式:包管理器、框架版本、如何启动开发环境、如何跑测试。
2. 目录结构:列出主要目录及其职责,标出哪些是业务代码、哪些是生成物。
3. 关键约定:命名风格、状态管理方式、错误处理惯例、提交规范。
4. 风险点:明显的技术债、缺测试的模块、写死的配置。

输出用中文,控制在 300 字以内,每条给出对应的文件路径作为依据。
勘察完成后停下等我下一步指令。

HOW TO USE

怎么使用这个提示词

  1. 01替换占位符把花括号里的示例换成你的真实目标、材料和约束。
  2. 02保留输出要求格式与验收条件能减少来回补充信息,不建议第一次就删掉。
  3. 03按结果微调一次只调整一个条件,便于判断哪项要求真正影响了结果。

相关标签

  • 上手
  • 代码理解

RELATED

同类提示词模板