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