README

!cheat.sh logo

Unified access to the best community driven cheat sheets repositories of the world.

Let's imagine for a moment that there is such a thing as an ideal cheat sheet.
What should it look like?
What features should it have?

 Concise — It should only contain the things you need, and nothing else.
 Fast — It should be possible to use it instantly.
 Comprehensive — It should contain answers for every possible question.
 Universal — It should be available everywhere, anytime, without any preparations.
 Unobtrusive — It should not distract you from your main task.
 Tutoring — It should help you to learn the subject.
 Inconspicuous — It should be possible to use it completely unnoticed.

Such a thing exists! It's easy to install and there's even auto-complete.


 Features

cheat.sh

 Has a simple curl/browser/editor interface.
 Covers 56 programming languages, several DBMSes, and more than 1000 most important UNIX/Linux commands.
 Provides access to the best community driven cheat sheets repositories in the world, on par with StackOverflow.
 Available everywhere, no installation needed, but can be installed for offline usage.
 Ultrafast, returns answers within 100 ms, as a rule.
 Has a convenient command line client, cht.sh, that is very advantageous and helpful, though not mandatory.
 Can be used directly from code editors, without opening a browser and not switching your mental context.
 Supports a special stealth mode where it can be used fully invisibly without ever touching a key and making sounds.


  


 Contents

 Features
 Usage
 Command line client, cht.sh
   Installation
   Client usage
   Tab-completion
    - Bash Tab completion
    - ZSH Tab completion
   Stealth mode
   Windows command line client
 Self-Hosting
   Docker
 Editors integration
   Vim
   Emacs
   Visual Studio Code
   Sublime
   IntelliJ IDEA
   QT Creator
 Special pages
 Search
 Programming languages cheat sheets
 Cheat sheets sources
 How to contribute
   How to edit a cheat sheet
   How to add a cheat sheet
   How to add a cheat sheet repository

 Usage

To get a cheat sheet for a UNIX/Linux command from a command line, query the service using curl or any other HTTP/HTTPS client
specifying the name of the command in the query:


    curl cheat.sh/tar
    curl cht.sh/curl
    curl https://cheat.sh/rsync
    curl https://cht.sh/tr

As you can see, you can use both HTTPS and HTTP to access the service, and both the long (cheat.sh) and the short (cht.sh) service names.

Here tar, curl, rsync, and tr are names of the UNIX/Linux commands you want to get cheat sheets for.

If you don't know the name of the command you need, you can search for it using the ~KEYWORD notation.
For example, to see how you can make snapshots of a filesystem/volume/something else:

    curl cht.sh/~snapshot



  


The programming language cheat sheets are located in special namespaces dedicated to them.


    curl cht.sh/go/Pointers
    curl cht.sh/scala/Functions
    curl cht.sh/python/

Top issues