create-tldr-page

Generate TLDR-formatted markdown pages from command-line tool documentation.

Updated Mar 8, 2026
One-click install
npx skills add https://github.com/tamago0224/kuroshio-mta --skill create-tldr-page-tamago0224
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: create-tldr-page
Source: https://github.com/tamago0224/kuroshio-mta/tree/main/.agents/skills/create-tldr-page
Command: npx skills add https://github.com/tamago0224/kuroshio-mta --skill create-tldr-page-tamago0224

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It eliminates the need for manual conversion of lengthy command documentation into short, standardized TLDR pages, saving time for developers and technical writers.

Core Features & Use Cases

  • Validates that a documentation URL is provided and fetches the content when needed.
  • Extracts the most common usage examples and formats them according to the TLDR‑pages project standards.
  • Handles missing inputs by prompting for the required command name or URL, ensuring reliable output.

Quick Start

Use the create‑tldr‑page skill with a command name and its documentation URL to generate a TLDR page.

Frequently Asked Questions about create-tldr-page

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

FAQPage Schema
How do I generate a TLDR page from command-line documentation?

To generate a TLDR page, provide a command name and its documentation URL or file. The skill fetches content, extracts common usage examples, and formats them into standardized TLDR markdown with placeholders for user-supplied arguments.

What is a TLDR page and when do I need to create one?

A TLDR page is a concise markdown document containing the most common usage examples for a command-line tool. You need to create one to simplify lengthy authoritative documentation into quick, accessible command references.

Can I use a local documentation file to extract TLDR examples instead of a URL?

Yes, you can supply a local documentation file as input. The skill accepts a command name along with a file path, extracts relevant examples, and formats them according to the TLDR-pages template without requiring a web URL.

What is the best way to automate markdown creation for command-line tools?

Automating markdown creation for command-line tools is best handled by extracting usage examples directly from authoritative documentation. This skill validates the source, pulls key examples, and outputs standardized TLDR-formatted markdown automatically.

Do I need to provide both a command name and a documentation source to generate markdown?

Yes, both a command name and a documentation source are required. If either input is missing, the skill handles the gap by prompting you to supply the required command name or URL, ensuring reliable TLDR markdown output.