tldr

Report bug · Request feature

Table of contents

• Overview
• Screenshots
• Build and run
• Bugs and feature requests
• Contributing
• Copyright and license

Overview

The tldr pages project is a collection of community-maintained help pages for command-line tools, that aims to be a simpler, more approachable complement to traditional man pages.

Maybe you are new to the command-line world? Or just a little rusty? Or perhaps you can't always remember the arguments to lsof, or tar?

It certainly doesn't help that the first option explained in man tar is:

-b blocksize
Specify the block size, in 512-byte records, for tape drive I/O.

This app is just that: an ever-growing collection of examples for the most common UNIX, Linux, macOS, SunOS and Windows command-line tools.

Screenshots

Build and run

• Assuming this is your first project, install flutter
• Clone this project using the url or ssh and cd into the cloned directory
• Get the dependencies with flutter pub get
• Run the app in debug mode with flutter run

Bugs and feature requests

Please open a new issue.

Contributing

Currently open to all contributions. Hit those issue and PR buttons.

Thanks

• tldr-pages for command documentation and logo
• Hotpot.ai for the screenshot templates and graphics generatorw
• Cas van Luijtelaar for the flare url

Copyright and license

Code released under the MIT License.