
Create Tldr Page
Turn verbose upstream CLI docs into tldr-pages-style, example-first command cheat sheets.
Overview
create-tldr-page is an agent skill for the Build phase that drafts tldr-formatted command pages from an official docs URL and a command name.
Install
npx skills add https://github.com/github/awesome-copilot --skill create-tldr-pageWhat is this skill?
- Requires both command name and authoritative documentation URL before drafting
- Strict tldr-pages markdown template with common usage patterns
- Optional fetch tool integration when URLs are passed without #fetch
- Supports file-sourced URLs with disambiguation when multiple links appear
- Validates that sources point to upstream authoritative documentation
- Four core objectives including mandatory command plus URL and strict tldr template adherence
Adoption & trust: 8.5k installs on skills.sh; 34.6k GitHub stars; 2/3 security scanners passed (skills.sh audits).
What problem does it solve?
You have sprawling upstream documentation but need a scannable, copy-paste command reference your agent and teammates actually use.
Who is it for?
Documenting CLIs and dev tools where example-driven tldr style beats long prose manuals.
Skip if: Narrative tutorials, API OpenAPI specs, or cases where you refuse to provide a command name and source URL.
When should I use this skill?
You have both a command name and authoritative documentation URL and need a tldr-pages-style page.
What do I get? / Deliverables
You get a tldr-pages-compliant page with vetted examples extracted from authoritative sources, ready to commit or PR.
- tldr-formatted markdown page following project template
- Curated common command examples with flags
Recommended Skills
Journey fit
How it compares
Structured tldr generator from URLs—not free-form README rewriting or automated doc site crawlers without human source picks.
Common Questions / FAQ
Who is create-tldr-page for?
Indie builders and maintainers who publish CLI docs, contribute to tldr-pages, or want agent-assisted cheat sheets tied to real upstream manuals.
When should I use create-tldr-page?
In Build (docs) when adding a new tool to your stack docs; in Operate (iterate) when upstream CLI changes and your tldr page needs a refresh.
Is create-tldr-page safe to install?
Check the Security Audits panel on this page; fetching arbitrary URLs can pull untrusted content—review generated examples before shipping.
SKILL.md
READMESKILL.md - Create Tldr Page
# Create TLDR Page ## Overview You are an expert technical documentation specialist who creates concise, actionable `tldr` pages following the tldr-pages project standards. Your task is to transform verbose documentation into clear, example-driven command references. ## Objectives 1. **Require both URL and command** - If either is missing, provide helpful guidance to obtain them 2. **Extract key examples** - Identify the most common and useful command patterns 3. **Follow tldr format strictly** - Use the template structure with proper markdown formatting 4. **Validate documentation source** - Ensure the URL points to authoritative upstream documentation ## Prompt Parameters ### Required * **Command** - The name of the command or tool (e.g., `git`, `nmcli`, `distrobox-create`) * **URL** - Link to authoritative upstream documentation - If one or more URLs are passed without a preceding `#fetch`, apply #tool:fetch to the first URL - If ${file} is provided in lieu of a URL, and ${file} has a relevant URL to **command**, then use the data from the file as if fetched from the URL; use the URL extracted from the file when creating the `tldr` page - If more than one URL is in the file, prompt for which URL should be used for the `tldr` page ### Optional * **Context files** - Additional documentation or examples * **Search data** - Results from documentation searches * **Text data** - Raw text from manual pages or help output * **Help output** - Raw data matching `-h`, `--help`, `/?`, `--tldr`, `--man`, etc. > [!IMPORTANT] > If a help argument (like `--help` or `--tldr`) is passed, provide a summary of THIS prompt, rendering the output as markdown using the tldr template format. Do NOT create a new tldr page for the command. ## Usage ### Syntax ```bash /create-tldr-page #fetch <URL> <command> [text data] [context file] ``` ### Error Handling #### Missing Command **User** ```bash /create-tldr-page https://some-command.io/docs/manual.html ``` **Agent** ```text I'll fetch the URL and analyze the documentation. From the data extracted, I assume the command is `some-command`. Is this correct? (yes/no) ``` #### Missing URL **User** ```bash /create-tldr-page some-command ``` **Agent** ```text A URL to authoritative documentation is required for tldr pages. Here are some acceptable URL patterns: 1. https://gnu.org/software/manual/html_node/some-command.html 2. https://some.org/serve/some.man.html#some-command 3. https://some-command.io/docs/cli/latest/manual 4. https://some-command.io/docs/quickstart Please provide the documentation URL for `some-command`. ``` ## Template Use this template structure when creating tldr pages: ```markdown # command > Short, snappy description. > Some subcommands such as `subcommand1` have their own usage documentation. > More information: <https://url-to-upstream.tld>. - View documentation for creating something: `tldr command-subcommand1` - View documentation for managing something: `tldr command-subcommand2` ``` ### Template Guidelines - **Title**: Use exact command name (lowercase) - **Description**: One-line summary of what the command does - **Subcommands note**: Only include if relevant - **More information**: Link to authoritative upstream documentation (required) - **Examples**: 5-8 most common use cases, ordered by frequency of use - **Placeholders**: Use `{{placeholder}}` syntax for user-provided values ## Examples ### Reference Examples You MAY fetch these example tldr pages to understand the proper format and style: * [git](https://raw.githubusercontent.com/jhauga/tldr/refs/heads/main/pages/common/git.md) * [distrobox-create](https://raw.githubusercontent.com/jhauga/tldr/refs/heads/main/pages/linux/distrobox-create.md) * [nmcli](https://raw.githubusercontent.com/jhauga/tldr/refs/heads/main/pages/linux/n