name: tldr-overview description: 使用 TLDR 栈高效获取任何项目的概述
TLDR 项目概述
使用 TLDR 栈高效获取任何项目的概述。
触发条件
/overview或/tldr-overview- “给我这个项目的概述”
- “这个代码库里有什么”
- 开始处理一个不熟悉的项目
执行步骤
1. 文件树（导航图）
tldr tree . --ext .py # 或 .ts, .go, .rs
2. 代码结构（存在什么）
tldr structure src/ --lang python --max 50
返回：每个文件的函数、类、导入
3. 调用图入口点（架构）
tldr calls src/
返回：跨文件关系、主要入口点
4. 关键函数复杂性（热点）
对于找到的每个入口点：
tldr cfg src/main.py main # 获取复杂性
输出格式
## 项目概述: {project_name}
### 结构
{tree output - 文件和目录}
### 关键组件
{structure output - 每个文件的函数、类}
### 架构（调用图）
{calls output - 组件如何连接}
### 复杂性热点
{cfg output - 具有高循环复杂性的函数}
---
Token 成本: ~{N} tokens (对比 ~{M} 原始 = {savings}% 节省)
何时不使用
- 已经熟悉项目
- 处理特定文件（使用有针对性的 tldr 命令代替）
- 测试文件（需要完整上下文）
编程使用
from tldr.api import get_file_tree, get_code_structure, build_project_call_graph
# 1. 文件树
tree = get_file_tree("src/", extensions={".py"})
# 2. 代码结构
structure = get_code_structure("src/", language="python", max_results=50)
# 3. 调用图
calls = build_project_call_graph("src/", language="python")
# 4. 热点函数复杂性
for edge in calls.edges[:10]:
cfg = get_cfg_context("src/" + edge[0], edge[1])