Convert Figma logo to code with AI

tldr-pages logotldr

📚 Collaborative cheatsheets for console commands

50,319
4,105
50,319
202

Top Related Projects

12,273

cheat allows you to create and view interactive cheatsheets on the command-line. It was designed to help remind *nix system administrators of options for commands that they use frequently, but not frequently enough to remember.

38,110

the only cheat sheet you need

10,557

instant coding answers via the command line

🖥 📊 🕹 🛠 A curated list of command line apps

A very fast implementation of tldr in Rust.

14,818

An interactive cheatsheet tool for the command-line

Quick Overview

tldr-pages is a community-driven project that provides simplified and practical man pages. It aims to be a complement to traditional man pages by offering concise examples for common commands, making it easier for users to quickly find and understand how to use various command-line tools.

Pros

  • Simplified and easy-to-understand command examples
  • Community-driven, allowing for frequent updates and additions
  • Available in multiple languages
  • Accessible through various clients and platforms

Cons

  • May not cover all possible use cases or advanced options for commands
  • Relies on community contributions, which can lead to inconsistencies
  • Not a replacement for comprehensive man pages
  • May not always be up-to-date with the latest command versions

Getting Started

To use tldr-pages, you can install a client or access the pages directly through the web interface. Here's how to install the official Node.js client:

npm install -g tldr

Once installed, you can use the tldr command followed by the name of the command you want to look up:

tldr tar

This will display a simplified man page for the tar command with practical examples.

Alternatively, you can access the pages through the web interface at https://tldr.sh/ or contribute to the project by submitting pull requests on GitHub.

Competitor Comparisons

12,273

cheat allows you to create and view interactive cheatsheets on the command-line. It was designed to help remind *nix system administrators of options for commands that they use frequently, but not frequently enough to remember.

Pros of cheat

  • Supports personal cheatsheets and customization
  • Offers offline access to cheatsheets
  • Allows for more detailed explanations and examples

Cons of cheat

  • Smaller community and fewer contributors
  • Less standardized format for cheatsheets
  • Requires manual installation and setup

Code comparison

tldr:

$ tldr tar
# tar
# Archiving utility.
# Often combined with a compression method, such as gzip or bzip2.
# More information: https://www.gnu.org/software/tar/

- Create an archive from files:
  tar cf target.tar file1 file2 file3

cheat:

$ cheat tar
# To create an uncompressed archive:
tar -cvf /path/to/foo.tar /path/to/foo/

# To extract an uncompressed archive:
tar -xvf /path/to/foo.tar

Both tldr and cheat provide concise command-line examples for various tools and utilities. tldr focuses on providing a standardized, community-driven set of examples with a consistent format across all entries. cheat offers more flexibility in terms of content and allows users to create and maintain their own cheatsheets.

tldr is better suited for quick reference and standardized examples, while cheat excels in customization and more detailed explanations. The choice between the two depends on individual preferences and use cases.

38,110

the only cheat sheet you need

Pros of cheat.sh

  • Offers a wider range of programming languages and tools
  • Provides interactive shell access for exploring commands
  • Supports multiple output formats (text, markdown, syntax-highlighted code)

Cons of cheat.sh

  • Less community-driven, with fewer contributors
  • May contain more complex or advanced examples, which can be overwhelming for beginners

Code comparison

tldr:

$ tldr tar
tar

Archiving utility.
Often combined with a compression method, such as gzip or bzip2.

- [c]reate an archive and write it to a [f]ile:
  tar cf target.tar file1 file2 file3

cheat.sh:

$ curl cheat.sh/tar
tar
# To extract an uncompressed archive:
tar -xvf /path/to/foo.tar

# To create an uncompressed archive:
tar -cvf /path/to/foo.tar /path/to/foo/

Both projects aim to provide concise command-line examples, but cheat.sh offers more flexibility in terms of output formats and supported languages. tldr focuses on simplicity and community-driven content, making it more beginner-friendly. cheat.sh provides a broader range of examples and interactive features, which may be more appealing to advanced users. The choice between the two depends on the user's needs and preferences.

10,557

instant coding answers via the command line

Pros of howdoi

  • Provides direct answers to programming questions from the command line
  • Utilizes web scraping to fetch up-to-date information from Stack Overflow
  • Offers more detailed explanations and code snippets for specific problems

Cons of howdoi

  • May return irrelevant or outdated information if the question is not specific enough
  • Requires an internet connection to function
  • Can be slower to retrieve information compared to local documentation

Code comparison

howdoi:

def get_answer(query):
    url = get_stackoverflow_url(query)
    soup = BeautifulSoup(requests.get(url).text, 'html.parser')
    answer = soup.find('div', class_='accepted-answer').find('code')
    return answer.text

tldr:

#!/usr/bin/env bash
page=$(find . -name "$1.md" | head -n 1)
if [ -n "$page" ]; then
    cat "$page"
else
    echo "Page not found"
fi

Summary

howdoi is a dynamic tool that fetches answers from the web, providing detailed solutions to specific programming questions. It's beneficial for developers seeking immediate help with coding problems. However, it relies on internet connectivity and may sometimes return less accurate results.

tldr offers concise, curated command-line examples for various tools and commands. It's faster and works offline, but provides less detailed explanations compared to howdoi. The choice between the two depends on whether you need quick reference guides or more in-depth problem-solving assistance.

🖥 📊 🕹 🛠 A curated list of command line apps

Pros of awesome-cli-apps

  • Comprehensive list of CLI applications across various categories
  • Includes both popular and lesser-known tools, offering a wider range of options
  • Provides brief descriptions for each app, helping users understand their purpose

Cons of awesome-cli-apps

  • Lacks detailed usage instructions or examples for the listed applications
  • May require additional research to determine how to use specific tools
  • Not as frequently updated as tldr, potentially containing outdated information

Code comparison

While a direct code comparison isn't applicable in this case, we can compare the structure of entries in each repository:

tldr:

# command-name

> Brief description of the command.
> More information: <link to more info>.

- Example usage:

`command-name option1 option2`

- Another example:

`command-name different-option`

awesome-cli-apps:

- [app-name](link-to-app) - Brief description of the app.

The tldr repository focuses on providing concise usage instructions for individual commands, while awesome-cli-apps offers a curated list of CLI applications with brief descriptions.

A very fast implementation of tldr in Rust.

Pros of tealdeer

  • Written in Rust, offering better performance and memory safety
  • Supports offline caching of pages for faster access
  • Provides a customizable color scheme for improved readability

Cons of tealdeer

  • Smaller community and fewer contributors compared to tldr
  • Less extensive page coverage, as it relies on the tldr project for content
  • Requires compilation, which may be less convenient for some users

Code comparison

tldr (Python):

def get_page(language, platform, command):
    for directory in directories:
        if os.path.isfile(os.path.join(directory, language, platform, command + '.md')):
            with open(os.path.join(directory, language, platform, command + '.md'), 'r') as f:
                return f.read()

tealdeer (Rust):

pub fn find_page(config: &Config, page_name: &str) -> Result<Page> {
    let cache = Cache::new(config)?;
    cache.find_page(page_name)
        .or_else(|_| download_page(config, page_name))
}

Both projects aim to provide simplified command-line documentation, but tealdeer focuses on performance and offline capabilities, while tldr offers broader community support and content coverage. tealdeer's Rust implementation may appeal to developers seeking a more efficient solution, while tldr's Python codebase might be more accessible for contributions.

14,818

An interactive cheatsheet tool for the command-line

Pros of navi

  • Interactive and customizable: Users can create and edit their own cheatsheets
  • Supports multiple programming languages and shell integrations
  • Offers fuzzy search and autocompletion features

Cons of navi

  • Steeper learning curve due to more complex functionality
  • Requires installation and setup, unlike tldr's web-based option
  • May be overkill for users seeking simple command references

Code comparison

navi:

navi --query "git commit"
navi --cheatsheet <path> --query <cmd>

tldr:

tldr git commit
tldr --platform=linux tar

Key differences

  • navi focuses on interactive, customizable cheatsheets
  • tldr provides simple, community-curated command examples
  • navi offers more advanced features like fuzzy search and shell integration
  • tldr is more straightforward and accessible for quick reference

Both projects aim to simplify command-line usage, but cater to different user needs. navi is better suited for power users who want a customizable, interactive experience, while tldr is ideal for those seeking quick, standardized command references across various platforms.

Convert Figma logo designs to code with AI

Visual Copilot

Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.

Try Visual Copilot

README

tldr-pages

Build status Matrix chat Merged PRs GitHub contributors license

What is tldr-pages?

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're new to the command-line world? Perhaps you're just a little rusty or can't always recall the arguments for commands like lsof, or tar?

It certainly doesn't help that, in the past, the first option explained in man tar was:

$ man tar
...
-b blocksize
   Specify the block size, in 512-byte records, for tape drive I/O.
   As a rule, this argument is only needed when reading from or writing to tape drives,
   and usually not even then as the default block size of 20 records (10240 bytes) is very common.
...

There seems to be room for simpler help pages, focused on practical examples. How about:

Screenshot of the tldr client displaying the tar command.

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

How do I use it?

[!TIP] For browsing without installing a client on your computer, see the web client at https://tldr.inbrowser.app (with offline support using PWA).

A popular and convenient way to access these pages on your computer is to install the official Node.js client:

npm install -g tldr

Alternatively, you can also use the official Python client, which can be installed via pip3 (or other package managers):

pip3 install tldr

Linux and Mac users can also install the official Rust Client using Homebrew (or other package managers on other operating systems):

brew install tlrc

Then you have direct access to simplified, easy-to-read help for commands, such as tar, accessible through typing tldr tar instead of the standard man tar.

If you don't want to install any software, check out the PDF version instead.

[!NOTE] PDFs for translations are available for most languages. You can find them in the releases assets of the latest release.

There are also various other clients provided by the community, both for the command-line and for other platforms. For a comprehensive list of clients, head over to our Wiki.

How do I contribute to tldr-pages?

All contributions are welcome!

Some ways to contribute include:

  • Adding your favorite command that isn't covered.
  • Adding examples or improving the content of an existing page.
  • Adding requested pages from our issues with the help wanted label.
  • Translating pages into different languages.

All tldr pages are written in markdown, so they can be edited quite easily and changes can be submitted in pull requests here using Git on the command-line or using the GitHub web interface.

We strive to maintain a welcoming and collaborative community. If it's your first time contributing, have a look at the contributing guidelines, and go ahead!

If you'd like to contribute to translations, you can visit https://lukwebsforge.github.io/tldri18n/ to see the overall progress of all translations, and which translations are missing or outdated.

You are also welcome to join us on the matrix chatroom!

Similar projects

  • Command Line Interface Pages allows you to write standardized help pages for CLI, directories, and configs.

  • Cheat allows you to create and view interactive cheatsheets on the command-line. It was designed to help remind Unix system administrators of options for commands that they use frequently, but not frequently enough to remember.

  • cheat.sh Aggregates cheat sheets from multiple sources (including tldr-pages) into 1 unified interface.

  • devhints Rico's cheatsheets are not just focused on the command-line and include a plethora of other cheatsheets related to programming.

  • eg provides detailed examples with explanations on the command-line. Examples come from the repository, but eg supports displaying custom examples and commands alongside the defaults.

  • kb is a minimalist command-line knowledge base manager. kb can be used to organize your notes and cheatsheets in a minimalist and clean way. It also supports non-text files.

  • navi is an interactive cheatsheet tool, which allows you to browse through specific examples or complete commands on the fly.

  • bropages (deprecated) are a highly readable supplement to man pages. It shows concise, common-case examples for Unix commands. The examples are submitted by the user base, and can be voted up or down; the best entries are what people see first when they look up a command.

What does "tldr" mean?

TL;DR stands for "Too Long; Didn't Read". It originated as Internet slang, where it is used to indicate that a long text (or parts of it) has been skipped as too lengthy. Read more in How-To Geek's article.

NPM DownloadsLast 30 Days