Cascading cheat sheets

[chubin]

With our "cascading cheat sheets" mode (it will be described in README.md soon), you can create a hierarchy of cheat sheets servers, where each server delivers local cheat sheets + if a requested cheat sheet is not found, the query is forwarded to the upstream server (and so on).

cheat.sh
    ^
    |
cheat.my
    ^
    |
clients

For the user it looks fully transparent, it uses the same clients as always. The only difference is that the clients should be configured the correct server (is some clients are used; of course, if you use nothing but curl, you change nothing but the name of the server in the query):

curl cheat.my/secret

In this query, you ask the cheat.my server for the secret cheat sheet.

The main advantage of this mode is that you can have your own (private or maybe public but relevant only to you and to your team) cheat sheets, and at the same time, you can use the global cheat sheets to, without changing anything.

This issue is related to #5, #14, #97

To do:

• server side implementation
• cheat.sh docker container (almost implemented by @bglopez)
• documentation (README.md)
• cht.sh client custom server support
• cheat.sh-vim custom server support (@dbeniamine)
• vscode-snippet custom server support (@mre)
• cheat-sh.el custom server support (@davep)
• cheat.sh-sublime-plugin custom server support (@gauravk-in)
• windows client custom server support (@tpanj )

[dbeniamine]

In cheat.sh-vim, the user can already set the server url by adding the following to its vimrc :

let g:CheatSheetBaseUrl='https://cht.sh'

[chubin]

@dbeniamine Perfect!

[davep]

The url for cheat.sh is a constant in my Emacs package, although I guess with this approach it'd make more sense to have it be a defcustom.

[mre]

Added to vscode-snippet via mre/vscode-snippet@1df3034.

[chubin]

@mre Thank you, Matthias!
@davep Thank you Dave, I agree with you, defcustom would make more sense

[tpanj]

Support for windows client added: https://github.com/tpanj/cht.exe/releases/tag/v0.6

[chubin]

@tpanj Perfect, Tadej! Thank you very much (updated the main page)

[zweicoder]

hey @chubin what's the status on this and where can one help? also does this allow me to have my own cheatsheets in my own Github repo that I can point it to, or is the only option now to deploy it myself?

[chubin]

@zweicoder This mode will be available soon (and the second important feature, offline usage, too). The problem was that it was hard to implement these features (as well as several other features) without some refactoring, and it is almost done. With the new cascading cheat sheets feature it will be possible to have your own cheat sheets, and even your own adapters to connect other information sources such as Jira for example

[zweicoder]

that sounds awesome! i was planning to add some quick hack to have an offline cache but since you guys will have it soon I'll wait patiently :)

[chubin]

but keep in mind that in the first version with offline cheat sheets support, it will be not possible to make arbitrary programming languages queries (not yet); only cheat sheet queries:

this will work:

cht.sh tar
cht.sh btrfs
cht.sh python/Functions

And this wont:

cht.sh python/read+yaml+file