mcpField
T
tldr-overview

tldr-overview

github.com/parcadeiDevelopment3.9k487 installsUpdated 39w ago
Repository

About tldr-overview

A skill that produces a token-efficient project overview using TLDR commands to map files, code structure, call relationships, and complexity.

Key features

  1. 01Generate a file tree
  2. 02Inspect code structure
  3. 03Map call graph entry points
  4. 04Check function complexity

Use cases

  1. 01Getting oriented in an unfamiliar project
  2. 02Reviewing project architecture before work

Install

Copy the command and run it in a terminal.

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

After installing, type/tldr-overviewin Claude Code to confirm it loaded.

Details

From the project README

TLDR Project Overview

Get a token-efficient overview of any project using the TLDR stack.

Trigger

  • /overview or /tldr-overview
  • "give me an overview of this project"
  • "what's in this codebase"
  • Starting work on an unfamiliar project

Execution

1. File Tree (Navigation Map)
tldr tree . --ext .py    # or .ts, .go, .rs
2. Code Structure (What Exists)
tldr structure src/ --lang python --max 50

Returns: functions, classes, imports per file

3. Call Graph Entry Points (Architecture)
tldr calls src/

Returns: cross-file relationships, main entry points

4. Key Function Complexity (Hot Spots)

For each entry point found:

tldr cfg src/main.py main  # Get complexity

Output Format

## 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)

When NOT to Use

  • Already familiar with the project
  • Working on a specific file (use targeted tldr commands instead)
  • Test files (need full context)

Programmatic Usage

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])

Comments

Markdown supported