Navigate:
tldr-pages
~$TLDR0.3%

tldr-pages: Simplified command-line help pages

Community-maintained concise help pages for CLI tools with practical examples.

LIVE RANKINGS • 10:20 AM • STEADY
OVERALL
#134
49
DEVELOPER TOOLS
#25
6
30 DAY RANKING TREND
ovr#134
·Devel#25
STARS
61.5K
FORKS
5.1K
7D STARS
+213
7D FORKS
+22
See Repo:
Share:

Learn more about tldr-pages

tldr-pages is a collaborative documentation project that creates simplified help pages for command-line utilities across multiple operating systems. The pages are written in Markdown format and stored in a centralized repository, accessible through various client implementations in different programming languages. Each page follows a standardized format focusing on common use cases with practical examples rather than comprehensive technical specifications. The project supports commands from UNIX, Linux, macOS, Windows, Android, and other platforms, with content available in multiple languages through community translations.

tldr-pages

1

Example-Focused Format

Pages emphasize practical command examples with real-world use cases rather than exhaustive parameter documentation. Each entry demonstrates common scenarios users actually encounter.

2

Multi-Platform Coverage

Supports commands across diverse operating systems including UNIX variants, Windows, Android, and network devices like Cisco IOS. Content spans traditional system utilities to modern development tools.

3

Multiple Client Options

Accessible through official clients written in Python, Rust, and Node.js, plus community-developed alternatives. Also available as web interface, PDF downloads, and various platform-specific implementations.



vv2.3

Client specification v2.3: Option placeholders and old asset website deprecation date

  • Added longform/shortform specifications
  • Specify `common` as a supported platform option
  • Add the date of removal of the old asset website
  • Various grammar fixes
vv2.2

Client specification v2.2: New cache asset URLs, 10 years of TLDR pages

  • Removed redirect text from the caching section
  • Updated asset URLs to use GitHub releases
  • Add requirement to disambiguate triple-brace placeholders
  • Add notice to deprecate the old asset URLs
vv2.1

Client specification v2.1: Escaping placeholder syntax and automatic platform detection

  • Add requirement to support escaping the placeholder syntax in certain pages
  • Add suggestion to detect new platforms added to the relevant `pages` directory automatically
  • Numerous improvements throughout test suite and action workflows
  • Added a symlink for `pages` directory to `pages.en`

See how people are using tldr-pages

Loading tweets...


[ EXPLORE MORE ]

Related Repositories

Discover similar tools and frameworks used by developers