tldrl

View documentation for the original command

$ tldr tldr-lint

tldr [options] command
tldr --update
tldr --version

command
    The name of the command for which to retrieve simplified examples (e.g., ls, grep, tar).

-l, --list
    Lists all available tldr pages in the local cache.

-r, --random
    Displays a random tldr page, useful for discovering new commands or learning.

-p <platform>, --platform <platform>
    Specifies the operating system platform for which to display the page (e.g., linux, osx, windows, android, sunos). By default, it detects the current platform.

-s <query>, --search <query>
    Searches for tldr pages containing the specified keyword(s) in their names or descriptions.

-u, --update
    Updates the local cache of tldr pages by downloading the latest versions from the repository.

-c, --clear-cache
    Clears the locally stored tldr pages cache, forcing a fresh download on the next query.

-v, --version
    Displays the version information of the installed tldr client.

-h, --help
    Shows the help message and available options for the tldr client.

tldr (Too Long; Didn't Read) is a community-driven collection of simplified and practical examples for common Linux, macOS, and Windows command-line utilities.

It serves as a quick-reference alternative to traditional man pages, which can often be exhaustive and overwhelming for users just looking for basic syntax or common use cases. Instead of providing every possible option and detail, tldr focuses on showing practical, real-world examples of how commands are used, making it much faster to grasp essential functionality.

The project is maintained by a global community of contributors, ensuring that the content is current, relevant, and covers a wide array of commands and platforms. This collaborative nature makes tldr a highly valuable resource for developers and system administrators seeking concise, actionable command-line guidance.

tldr pages are community-contributed and focus on common use cases, so they may not cover every obscure option or edge case. For exhaustive documentation, the traditional man pages are still the definitive source. An internet connection is required for initial setup and updates of the page cache.

The content of tldr pages is entirely community-contributed and maintained. This collaborative model ensures that the pages are practical, up-to-date, and cover a wide range of real-world scenarios and commands across various operating systems.

tldr clients are available in various programming languages (e.g., Node.js, Python, Rust, Go) and can typically be installed via platform-specific package managers (e.g., apt install tldr on Debian/Ubuntu, brew install tldr on macOS) or language-specific package managers (e.g., npm install -g tldr, pip install tldr).

The tldr project was initiated by Romain Coeur in 2017 with the goal of creating a more accessible and example-driven complement to standard manual pages. Its simple, practical approach quickly resonated with developers and system administrators. Since its inception, a diverse community has grown around it, contributing new pages and maintaining existing ones, solidifying its role as a go-to resource for quick command-line assistance.

man(1), info(1), apropos(1)