tldr-overview

Solid

Get a token-efficient overview of any project using file tree, code structure, and call graph analysis.

AI & Automation 501 stars 42 forks Updated yesterday MIT

Install

View on GitHub

Quality Score: 89/100

Stars 20%
90
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
92
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# 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) ```bash tldr tree . --ext .py # or .ts, .go, .rs ``` ### 2. Code Structure (What Exists) ```bash tldr structure src/ --lang python --max 50 ``` Returns: functions, classes, imports per file ### 3. Call Graph Entry Points (Architecture) ```bash tldr calls src/ ``` Returns: cross-file relationships, main entry points ### 4. Key Function Complexity (Hot Spots) For each entry point found: ```bash 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 ```python from tldr.api import get_file_tree, get_code_structure, build_project_call_graph # 1. Tree tr...

Details

Author
vibeeval
Repository
vibeeval/vibecosystem
Created
2 months ago
Last Updated
yesterday
Language
C#
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category