create-tldr-page

Create tldr-style command reference pages from documentation URLs.

Updated Apr 14, 2026

Search Tags:#summarization #documentation #validation #formatting #cli #tldr

Ready to run

npx skills add https://github.com/BrunoAMSilva/my-config --skill create-tldr-page-brunoamsilva

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: create-tldr-page
Source: https://github.com/BrunoAMSilva/my-config/tree/main/coding/skills/create-tldr-page
Command: npx skills add https://github.com/BrunoAMSilva/my-config --skill create-tldr-page-brunoamsilva

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill converts long, scattered, or overly detailed CLI documentation into concise, example-driven tldr pages that are quick to read and follow.

Core Features & Use Cases

Require both a command name and an authoritative documentation URL and provide guidance when either is missing.
Extract and prioritize the most common and useful command examples and usage patterns for inclusion.
Enforce tldr-pages formatting, placeholder conventions, and include a required upstream "More information" link.
Validate that the source URL points to authoritative documentation and prompt for clarification if multiple candidate URLs are present.

Quick Start

Create a tldr page for the command using the provided authoritative documentation URL and include 5 to 8 representative examples.

Frequently Asked Questions about create-tldr-page

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I create a tldr page from CLI documentation?▼

To create a tldr page, you provide a command name and an authoritative documentation URL. It extracts common usage patterns and formats them into concise, example-driven CLI references with an upstream link.

What is the best way to summarize command line tool documentation?▼

The best way to summarize command line documentation is to extract representative examples and validate source credibility. This approach converts scattered CLI help output into prioritized, example-driven tldr formatting.

Can I use help output to generate tldr formatting for a CLI tool?▼

Yes, you can use help output to generate tldr formatting. The tool accepts help output, context files, or documentation URLs to extract common command examples and apply placeholder conventions.

Do I need an authoritative URL to extract command examples for a tldr page?▼

Yes, an authoritative URL is required to extract command examples for a tldr page. If a URL is missing or points to non-authoritative documentation, the tool prompts for clarification.

How many examples should a tldr page include when summarizing documentation?▼

A tldr page should include 5 to 8 representative examples when summarizing documentation. It prioritizes the most common and useful command usage patterns extracted from the provided source.

What happens if multiple candidate URLs are provided for tldr page validation?▼

When multiple candidate URLs are provided for tldr page validation, the tool prompts for clarification. It validates that the source URL points to authoritative documentation before extracting examples.