# tldr
> Simplified and community-driven man pages

## 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

## When to Use
- 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

## When NOT to Use
- Need comprehensive documentation (use man pages)
- Need info about obscure flags or edge cases
- 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

## Installation
- **homebrew**: `brew install tldr`
- **npm**: `npm install -g tldr`
- **pip**: `pip install tldr`

---
Source: https://littlescripts.sh/tools/tldr
