tldrl

View documentation for the original command

$ tldr tldr-lint

tldr

    The name of the command to look up in the tldr pages repository.

-u, --update
    Update the local cache of tldr pages.

-v, --version
    Display the version of the tldr client.

-h, --help
    Display help information about the tldr client.

-p, --platform
    Specify the platform. Available platforms: linux, osx, sunos, windows.

-c, --clear-cache
    Clear the cache of tldr pages.

-d, --dry-run
    Simulate update without modifying the cache.

tldr provides simplified and community-driven man pages for command-line tools. Instead of presenting comprehensive documentation, tldr focuses on providing concise, practical examples and common use cases to help users quickly understand and use commands. It aims to be more approachable and easier to understand than traditional man pages, making it an excellent resource for beginners and experienced users alike. The pages are written in a Markdown-like syntax and are hosted on GitHub, allowing for community contributions and continuous improvement. Users can contribute by suggesting edits, adding examples, or creating pages for commands not yet covered. The tldr pages are typically accessed through a command-line client, which fetches the relevant page from the tldr repository. It prioritizes clarity and ease of use, offering a quicker way to grasp a command's purpose and common applications.

Requires an internet connection to download or update tldr pages. The quality and completeness of the tldr pages depend on community contributions. Not all commands have tldr pages available.

tldr tar
Displays simplified examples for using the 'tar' command.

tldr git commit
Displays simplified examples for using the 'git commit' command.

The tldr project was created to address the perceived complexity and verbosity of traditional man pages. It was designed to be more accessible to new users and provide quick reference for common use cases. The project relies on community contributions and has grown to cover a wide range of commands. The client exists in different languages such as nodejs, python, rust etc.

man(1), apropos(1), help