Posix sh

.dockerignore

@@ -1,4 +1,3 @@
-.travis.yml
 .git
 .gitignore
 docker-compose.yml

.github/workflows/tests-ubuntu.yml

@@ -0,0 +1,38 @@
+name: Ubuntu Tests
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+  schedule:
+    - cron:  '0 9 * * 4'
+
+jobs:
+  build:
+    runs-on: ubuntu-20.04
+    steps:
+    - uses: actions/checkout@v2
+    - name: install dependencies
+      run: pip install --upgrade -r requirements.txt
+    - name: fetch upstream cheat sheets
+      run: python lib/fetch.py fetch-all
+    - name: run bash tests
+      run: bash tests/run-tests.sh
+    - name: run pytest
+      run: pytest lib/
+
+  docker:
+    runs-on: ubuntu-20.04
+    steps:
+    - uses: actions/checkout@v2
+    - run: docker-compose build
+    - run: docker images
+    - run: |
+        docker-compose -f docker-compose.yml up -d
+        # docker-compose -f docker-compose.yml -f docker-compose.debug.yml up -d
+        docker-compose ps
+        # wait until the web server is up
+        wget --timeout 3 --tries=5 --spider localhost:8002 2>&1 | grep -i http
+        docker-compose logs --no-color
+    - run: CHEATSH_TEST_STANDALONE=NO bash tests/run-tests.sh

Dockerfile

@@ -1,15 +1,17 @@
-FROM alpine:3.12
+FROM alpine:3.14
 # fetching cheat sheets
 ## installing dependencies
 RUN apk add --update --no-cache git py3-six py3-pygments py3-yaml py3-gevent \
-      libstdc++ py3-colorama py3-requests py3-icu py3-redis
-## building missing python packages
-RUN apk add --no-cache --virtual build-deps py3-pip g++ python3-dev \
-    && pip3 install --no-cache-dir rapidfuzz colored polyglot pycld2 \
-    && apk del build-deps
+      libstdc++ py3-colorama py3-requests py3-icu py3-redis sed
 ## copying
 WORKDIR /app
 COPY . /app
+## building missing python packages
+RUN apk add --no-cache --virtual build-deps py3-pip g++ python3-dev libffi-dev \
+    && pip3 install --no-cache-dir --upgrade pygments \
+    && pip3 install --no-cache-dir -r requirements.txt \
+    && apk del build-deps
+# fetching dependencies
 RUN mkdir -p /root/.cheat.sh/log/ \
     && python3 lib/fetch.py fetch-all
 

README.md

@@ -1,4 +1,5 @@
 
+
 ![cheat.sh logo](http://cheat.sh/files/big-logo-v2-fixed.png)
 
 Unified access to the best community driven cheat sheets repositories of the world.
@@ -15,22 +16,21 @@ What features should it have?
 * **Tutoring** — It should help you to learn the subject.
 * **Inconspicuous** — It should be possible to use it completely unnoticed.
 
-Such a thing exists.
+Such a thing exists! It's easy to [install](#installation) and there's even [auto-complete](#tab-completion).
 
-[![Build Status](https://travis-ci.org/chubin/cheat.sh.svg?branch=master)](https://travis-ci.org/chubin/cheat.sh)
 
 ## Features
 
 **cheat.sh**
 
-* Has a simple curl/browser interface.
+* 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.
+* 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 and making sounds.
+* Supports a special stealth mode where it can be used fully invisibly without ever touching a key and making sounds.
 
 <p align="center">
   <img src='https://cheat.sh/files/demo-curl.gif'/>
@@ -44,7 +44,10 @@ Such a thing exists.
   * [Installation](#installation)
   * [Client usage](#client-usage)
   * [Tab-completion](#tab-completion)
+    - [Bash Tab completion](#bash-tab-completion)
+    - [ZSH Tab completion](#zsh-tab-completion)
   * [Stealth mode](#stealth-mode)
+  * [Windows command line client](#windows-command-line-client)
 * [Self-Hosting](#self-hosting)
   * [Docker](#docker)
 * [Editors integration](#editors-integration)
@@ -188,6 +191,8 @@ Try your own queries. Follow these rules:
 
 Read more about the programming languages queries below.
 
+----
+
 ## Command line client, cht.sh
 
 The cheat.sh service has its own command line client (`cht.sh`) that
@@ -203,17 +208,18 @@ has several useful features compared to querying the service directly with `curl
 
 To install the client:
 
-```
-    mkdir -p ~/bin/
-    curl https://cht.sh/:cht.sh > ~/bin/cht.sh
-    chmod +x ~/bin/cht.sh
+```bash
+PATH_DIR="$HOME/bin"  # or another directory on your $PATH
+mkdir -p "$PATH_DIR"
+curl https://cht.sh/:cht.sh > "$PATH_DIR/cht.sh"
+chmod +x "$PATH_DIR/cht.sh"
 ```
 
 or to install it globally (for all users):
 
-```
-    curl https://cht.sh/:cht.sh | sudo tee /usr/local/bin/cht.sh
-    chmod +x /usr/local/bin/cht.sh
+```bash
+curl https://cht.sh/:cht.sh | sudo tee /usr/local/bin/cht.sh
+chmod +x /usr/local/bin/cht.sh
 ```
 
 Note: The package "rlwrap" is a required dependency to run in shell mode. Install this using `sudo apt install rlwrap`
@@ -301,21 +307,21 @@ Use it to specify query options that you would use with each query.
 For example, to switch syntax highlighting off create the file with the following
 content:
 
-```
+```bash
 CHTSH_QUERY_OPTIONS="T"
 ```
 
 Or if you want to use a special syntax highlighting theme:
 
-```
+```bash
 CHTSH_QUERY_OPTIONS="style=native"
 ```
 
 (`curl cht.sh/:styles-demo` to see all supported styles).
 
 Other cht.sh configuration parameters:
 
-```
+```bash
 CHTSH_CURL_OPTIONS="-A curl"        # curl options used for cht.sh queries
 CHTSH_URL=https://cht.sh            # URL of the cheat.sh server
 ```
@@ -327,22 +333,24 @@ CHTSH_URL=https://cht.sh            # URL of the cheat.sh server
 
 To activate tab completion support for `cht.sh`, add the `:bash_completion` script to your `~/.bashrc`:
 
-```
-    $ curl https://cheat.sh/:bash_completion > ~/.bash.d/cht.sh
-    $ . ~/.bash.d/cht.sh
-    $ # and add . ~/.bash.d/cht.sh to ~/.bashrc
+```bash
+    curl https://cheat.sh/:bash_completion > ~/.bash.d/cht.sh
+    . ~/.bash.d/cht.sh
+    # and add . ~/.bash.d/cht.sh to ~/.bashrc
 ```
 
 #### ZSH Tab completion
 
 To activate tab completion support for `cht.sh`, add the `:zsh` script to the *fpath* in your `~/.zshrc`:
 
-```
-    $ curl https://cheat.sh/:zsh > ~/.zsh.d/_cht
-    $ echo 'fpath=(~/.zsh.d/ $fpath)' >> ~/.zshrc
-    $ # Open a new shell to load the plugin
+```zsh
+    curl https://cheat.sh/:zsh > ~/.zsh.d/_cht
+    echo 'fpath=(~/.zsh.d/ $fpath)' >> ~/.zshrc
+    # Open a new shell to load the plugin
 ```
 
+----
+
 ### Stealth mode
 
 Being used fully unnoticed is one of the most important property of any cheat sheet.
@@ -443,6 +451,8 @@ You can also use [`scoop`](https://github.com/lukesampson/scoop) command-line in
 scoop install cht
 ```
 
+----
+
 ## Self-Hosting
 
 ### Docker
@@ -530,7 +540,7 @@ In this example, several Vim plugins are used:
 * [scrooloose/syntastic](https://github.com/vim-syntastic/syntastic) — Syntax checking plugin
 * [cheat.sh-vim](https://github.com/dbeniamine/cheat.sh-vim) — Vim support
 
-Syntastic shows warnings and errors (found by code analysis tools: `jshint`, `merlin`, `pylint`, `shellcheckt etc.),
+Syntastic shows warnings and errors (found by code analysis tools: `jshint`, `merlin`, `pylint`, `shellcheck` etc.),
 and `cheat.sh-vim` shows you explanations for the errors and warnings
 and answers on programming languages queries written in the editor.
 
@@ -658,6 +668,7 @@ Other pages:
     :post               how to post new cheat sheet
     :styles             list of color styles
     :styles-demo        show color styles usage examples
+    :random             fetches a random page (can be used in a subsection too: /go/:random)
 ```
 
 ## Search
@@ -813,15 +824,17 @@ and information sources, maintained by thousands of users, developers and author
 all over the world
 (in the *Users* column number of contributors/number of stars is shown):
 
-|Cheat sheets           |Repository                                            | Users | Creation Date |
-|-----------------------|------------------------------------------------------|------------|---------------|
-|UNIX/Linux, programming|[cheat.sheets](https://github.com/chubin/cheat.sheets)| 38/223       | May 1, 2017   |
-|UNIX/Linux commands    |[tldr-pages/tldr](https://github.com/tldr-pages/tldr) | 760/23158  | Dec 8, 2013   |
-|UNIX/Linux commands    |[chrisallenlane/cheat](https://github.com/chrisallenlane/cheat)|131/5240|Jul 28, 2013|
-|Programming languages  |[adambard/learnxinyminutes-docs](https://github.com/adambard/learnxinyminutes-docs)|1246/6748|Jun 23, 2013|
-|Go                     |[a8m/go-lang-cheat-sheet](https://github.com/a8m/go-lang-cheat-sheet)|31/4039|Feb 9, 2014|
-|Perl                   |[pkrumnis/perl1line.txt](https://github.com/pkrumins/perl1line.txt)|5/190|Nov 4, 2011|
-|Programming languages  |[StackOverflow](https://stackoverflow.com)|9M |Sep 15, 2008|
+|Cheat sheets           |Repository                                                                          |C/U*                                                                                                                  |Stars                                                                                                   |Creation Date|
+|-----------------------|------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------|-------------|
+|UNIX/Linux, programming|[cheat.sheets](https://github.com/chubin/cheat.sheets)                              |![](https://img.shields.io/github/contributors-anon/chubin/cheat.sheets?label=%F0%9F%91%A5&labelColor=white)           |![](https://img.shields.io/github/stars/chubin/cheat.sheets?label=%E2%AD%90&labelColor=white)           |May 1, 2017  |
+|UNIX/Linux commands    |[tldr-pages/tldr](https://github.com/tldr-pages/tldr)                               |![](https://img.shields.io/github/contributors-anon/tldr-pages/tldr?label=%F0%9F%91%A5&labelColor=white)                           |![](https://img.shields.io/github/stars/tldr-pages/tldr?label=%E2%AD%90&labelColor=white)               |Dec 8, 2013  |
+|UNIX/Linux commands    |[chrisallenlane/cheat](https://github.com/chrisallenlane/cheat)                     |![](https://img.shields.io/github/contributors-anon/chrisallenlane/cheat?label=%F0%9F%91%A5&labelColor=white)          |![](https://img.shields.io/github/stars/chrisallenlane/cheat?label=%E2%AD%90&labelColor=white)          |Jul 28, 2013 |
+|Programming languages  |[adambard/learnxinyminutes-docs](https://github.com/adambard/learnxinyminutes-docs) |![](https://img.shields.io/github/contributors-anon/adambard/learnxinyminutes-docs?label=%F0%9F%91%A5&labelColor=white)|![](https://img.shields.io/github/stars/adambard/learnxinyminutes-docs?label=%E2%AD%90&labelColor=white)|Jun 23, 2013 |
+|Go                     |[a8m/go-lang-cheat-sheet](https://github.com/a8m/go-lang-cheat-sheet)               |![](https://img.shields.io/github/contributors-anon/a8m/go-lang-cheat-sheet?label=%F0%9F%91%A5&labelColor=white)       |![](https://img.shields.io/github/stars/a8m/go-lang-cheat-sheet?label=%E2%AD%90&labelColor=white)       |Feb 9, 2014  |
+|Perl                   |[pkrumnis/perl1line.txt](https://github.com/pkrumins/perl1line.txt)                 |![](https://img.shields.io/github/contributors-anon/pkrumins/perl1line.txt?label=%F0%9F%91%A5&labelColor=white)        |![](https://img.shields.io/github/stars/pkrumins/perl1line.txt?label=%E2%AD%90&labelColor=white)        |Nov 4, 2011  |
+|Programming languages  |[StackOverflow](https://stackoverflow.com)                                          |[14M](https://stackexchange.com/leagues/1/alltime/stackoverflow)                                                       |N/A                                                                                                     |Sep 15, 2008 |
+
+<sup>(*) C/U — contributors for GitHub repositories, Users for Stackoverflow</sup>
 
 Pie diagram reflecting cheat sheets sources distribution (by number of cheat sheets on cheat.sh originating from a repository):
 
@@ -865,3 +878,15 @@ If you want to add a cheat sheet repository to cheat.sh, please open an issue:
 * [Add a new repository](https://github.com/chubin/cheat.sh/issues/new)
 
 Please specify the name of the repository, and give its short description.
+
+
+## Installation and standalone usage
+
+You don't need to install anything, to start using *cheat.sh*.
+
+There are two cases, when you want to install *cheat.sh* locally:
+
+1. You plan to use it off-line, without Internet access;
+2. You want to use your own cheat sheets (additionally, or as a replacement).
+
+Installation process in described in details here: [cheat.sh standalone installation](doc/standalone.md)