mcpField
T
tldr-overview

tldr-overview

github.com/parcadei开发3.9k487 次安装39 周前更新
代码仓库

关于 tldr-overview

使用 TLDR 命令生成精简项目概览的 Skill，可梳理文件树、代码结构、调用关系和复杂度。

主要功能

  1. 01生成文件树
  2. 02检查代码结构
  3. 03梳理调用图入口
  4. 04查看函数复杂度

适用场景

  1. 01熟悉陌生项目
  2. 02开始工作前了解项目架构

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/parcadei/continuous-claude-v3 --skill tldr-overview

安装后在 Claude Code 中输入/tldr-overview确认已加载。

详细介绍

TLDR 项目概览

使用 TLDR 技术栈，高效概览任意项目。

触发方式

  • /overview 或 /tldr-overview
  • “概览一下这个项目”
  • “这个代码库里有什么”
  • 开始着手一个不熟悉的项目

执行

1. 文件树（导航地图）
tldr tree . --ext .py    # or .ts, .go, .rs
2. 代码结构（现有内容）
tldr structure src/ --lang python --max 50

返回：每个文件中的函数、类和导入项

3. 调用图入口点（架构）
tldr calls src/

返回：跨文件关系、主要入口点

4. 关键函数复杂度（热点）

针对找到的每个入口点：

tldr cfg src/main.py main  # Get complexity

输出格式

## Project Overview: {project_name}

### Structure
{tree output - files and directories}

### Key Components
{structure output - functions, classes per file}

### Architecture (Call Graph)
{calls output - how components connect}

### Complexity Hot Spots
{cfg output - functions with high cyclomatic complexity}

---
Token cost: ~{N} tokens (vs ~{M} raw = {savings}% savings)

不适用场景

  • 已熟悉该项目
  • 正在处理特定文件（请改用针对性的 tldr 命令）
  • 测试文件（需要完整上下文）

编程方式使用

from tldr.api import get_file_tree, get_code_structure, build_project_call_graph

# 1. Tree
tree = get_file_tree("src/", extensions={".py"})

# 2. Structure
structure = get_code_structure("src/", language="python", max_results=50)

# 3. Call graph
calls = build_project_call_graph("src/", language="python")

# 4. Complexity for hot functions
for edge in calls.edges[:10]:
    cfg = get_cfg_context("src/" + edge[0], edge[1])

评论

支持 Markdown