tldr

Simplified and community-driven man pages

Documentation Productivity Shell & Terminal linuxmacoswindows Various MIT

Description

tldr-pages is a collection of community-maintained help pages for command-line tools that provides simplified, practical examples. Unlike traditional man pages, tldr pages focus on common use cases with clear, copy-pasteable examples.

Install

homebrewbrew install tldr

npmnpm install -g tldr

pippip install tldr

AI Summary

Practical, example-driven command help. Like man pages but focused on common use cases with copy-pasteable examples. Community-maintained for thousands of commands.

Capabilities

+ Simplified help pages with practical examples
+ Cross-platform pages (Linux, macOS, Windows)
+ Community-maintained with thousands of commands
+ Offline cache for fast access
+ Multiple client implementations in various languages

Use When

→ Need quick examples for a command you forgot the syntax of
→ Learning a new command-line tool
→ Want practical examples instead of exhaustive man pages

Avoid When

x Need comprehensive documentation (use man pages)
x Need info about obscure flags or edge cases
x Working with domain-specific tools that tldr doesn't cover

Usage Patterns

Get examples for a command

tldr tar

Shows common tar usage examples

Show platform-specific page

tldr --os=linux systemctl

Shows Linux-specific examples for systemctl

Update local cache

tldr --update

Downloads the latest community-maintained pages

Input / Output

stdout: Formatted help page with examples

Exit codes:

0 Page found

1 Page not found or error

Typical Pipelines

tldr tar | less

View AGENTS.md for tldr