用途:为不熟悉的项目生成节省 token 的概览,适用于开始接触新代码库时快速了解整体结构。可通过 /overview 或 /tldr-overview 触发,或说“give me an overview of this project”“what's in this codebase”。
主要能力与执行步骤:
- 文件树(导航地图):tldr tree . --ext .py(也支持 .ts、.go、.rs)
- 代码结构:tldr structure src/ --lang python --max 50,返回每个文件的函数、类、导入。
- 调用图入口点(架构):tldr calls src/,返回跨文件关系和主要入口点。
- 关键函数复杂度(热点):对每个入口点执行 tldr cfg src/main.py main 获取复杂度。
输出格式包含:Structure(目录与文件)、Key Components(各文件函数与类)、Architecture(调用图,组件如何连接)、Complexity Hot Spots(高圈复杂度函数),以及 token 成本对比。
程序化用法示例:from tldr.api import get_file_tree, get_code_structure, build_project_call_graph;依次调用 get_file_tree、get_code_structure、build_project_call_graph,再对调用边用 get_cfg_context 获取复杂度。
限制与不适用场景:已熟悉该项目时、只处理某个具体文件时(应改用针对性 tldr 命令)、测试文件需要完整上下文时,不建议使用本概览。具体安装方式、支持语言细节及价格信息暂未提供。