Skip to content

This document is a WORK IN PROGRESS.
This is just a quick personal cheat sheet: treat its contents with caution!


help

Here is a list of popular tools in order to get some help about any CLI commands.


Table of contents


man

Reference(s)

Just run the following command in order to know everything there is to know about man (the default interface to your Linux system reference manuals): $ man man.


tldr

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.

Reference(s)

Install

# emerge --ask --noreplace eselect-repository
# eselect repository enable guru
# emaint sync -r guru
# echo '*/*::guru ~amd64' >> /etc/portage/package.accept_keywords
# emerge -a app-text/tldr
# pacman -S tldr
# nix-env -iA nixos.tldr
# nix-env -iA nixpkgs.tldr
# apt install tldr

⚠️ Install the EPEL repository as a prerequisite! ⚠️

# yum install tldr

# dnf install tldr

Use

  • Get typical usages of a command, e.g. the tar command:

    $ tldr tar
    

  • Show the tar tldr page for Linux:

    $ tldr -p linux tar
    

  • Get help for a Git sub command (e.g. the git checkout sub command):

    $ tldr git-checkout
    

  • Update local pages (if the client supports caching):

    $ tldr -u
    


cheat.sh

A unified access to community driven cheat sheets repositories.

Reference(s)
  • Presentation of cheat.sh

    $ curl cheat.sh
    

  • How to use cheat.sh:

    $ curl cheat.sh/:help
    

  • More detailed introduction to cheat.sh:

    $ curl cheat.sh/:intro
    

  • Each programming language topic has the following subtopics:

    $ curl cheat.sh/lua/:learn
    $ curl cheat.sh/lua/:list
    

  • Search for a specific keyword (e.g. Battery) in a specific cheat sheet (e.g. MegaCli):

    $ curl cheat.sh/MegaCli~Battery
        > # Battery backup information
        > MegaCli -AdpBbuCmd -aALL
    

  • Search for a specific keyword (e.g. Battery) across all cheat sheets:

    $ curl cheat.sh/~Battery
        > ...
    

cht.sh client

Though it's perfectly possible to access cheat.sh using curl (or any other HTTP/HTTPS client) alone, there is a special client, that has several advantages comparing to plain curling: cht.sh.

To install the client in ~/bin:

$ curl https://cht.sh/:cht.sh > ~/bin/cht.sh
$ chmod +x ~/bin/cht.sh

Queries look the same, but you can separate words in the query with spaces, instead of + as when using curl, what looks more natural:

$ cht.sh python zip lists

(Neo)vim plugin

See $ curl cheat.sh/:vim (and https://github.com/dbeniamine/cheat.sh-vim).


cheatsheets

TL;DR for developer documentation - a nice collection of cheat sheets to read on devhints.io.

Reference(s)

Reference(s)

TODO


cheat

Reference(s)

TODO


kb

Reference(s)

TODO


eg

Reference(s)

TODO


If this cheat sheet has been useful to you, then please consider leaving a star here.