tldr
[!NOTE|label:references:]
install
# node version
$ npm install -g tldr
# -- usage --
$ $(npm config get prefix)/bin/tldr --theme ocean <cmd>
# rust version
$ brew install --HEAD tlrc
# c version
$ brew install --HEAD tldr
# python version
$ python3 -m pip install tldr
config
rust version
[!TIP|label:references:]
- config file :
- linux and bsd:
$XDG_CONFIG_HOME/tlrc/config.tomlor~/.config/tlrc/config.tomlif$XDG_CONFIG_HOMEis unset - macos:
~/Library/Application Support/tlrc/config.toml - windows:
%ROAMINGAPPDATA%\tlrc\config.toml
- linux and bsd:
- iMarslo: .tlrc.toml
export TLRC_CONFIG="$HOME/.marslo/.tlrc.toml"
# rust version # -- default configure -- $ tldr --gen-config > $(tldr --config-path) # -- user defined configure -- $ export TLRC_CONFIG="$HOME/.marslo/.tlrc.toml" # or $ tldr --config "$HOME/.marslo/.tlrc.toml" <cmd>- config file :
python version
# tldr-pypi : https://pypi.org/project/tldr/ export TLDR_COLOR_NAME='cyan' export TLDR_COLOR_DESCRIPTION='white' export TLDR_COLOR_EXAMPLE='green' export TLDR_COLOR_COMMAND='red' export TLDR_COLOR_PARAMETER='white' export TLDR_LANGUAGE='en' export TLDR_CACHE_ENABLED=1 export TLDR_CACHE_MAX_AGE=720 export TLDR_PAGES_SOURCE_LOCATION='https://raw.githubusercontent.com/tldr-pages/tldr/main/pages' export TLDR_DOWNLOAD_CACHE_LOCATION='https://tldr-pages.github.io/assets/tldr.zip'
cht.sh
[!NOTE|label:references:]
# install
$ curl -fsSL https://cht.sh/:cht.sh --create-dirs -o ~/.local/bin/cht.sh
$ chmod +x ~/.local/bin/cht.sh
# completion
$ curl -fsSL https://cheat.sh/:bash_completion --create-dirs -o ~/.marslo/.completion/cht.sh
$ source ~/.marslo/.completion/cht.sh
# added in .bashrc
$ [[ -f "${iRCHOME}"/.completion/cht.sh ]] && source "${iRCHOME}"/.completion/cht.sh
with fzf
links
- :intro
- ~snapshot
- :vim
- :styles
- :styles-demo
- :list
- i.e.: python/:list
- :learn
- i.e.: python/:learn
.cht.sh.conf
[!NOTE|label:references:]
- path:
~/.cht.sh/- file :
~/.cht.sh/cht.sh.conf- cht.sh configuration is stored in
~/.cht.sh/(can be overridden withCHTSHenv var.)
CHTSH environment
| ENVIRONMENT VARIABLE | VALUE |
|---|---|
CHTSH_HOME |
~/.cht.sh/ |
CHTSH_CONF |
$CHTSH_HOME/cht.sh.conf |
CHTSH_URL |
https://cht.sh |
CHTSH_MODE |
$(cat "$CHTSH_HOME/mode 2>/dev/null") |
CHTSH_CURL_OPTIONS |
- |
CHEATSH_INSTALLATION |
$(cat "$CHTSH_HOME/standalone" 2>/dev/null) |
CHEATSH_TEST_STANDALONE |
YES/NO |
CHEATSH_TEST_SKIP_ONLINE |
YES/NO |
CHEATSH_TEST_SHOW_DETAILS |
YES/NO |
theme
list themes
$ cht.sh :styles # or $ curl cht.sh/:stylesshow themes
$ cht.sh :styles-demo # or $ cht.sh :styles | while read -r _s; do echo -e "\n---"; echo -e "${_s}"; echo -e "---"; curl "cheat.sh/bash/advanced?style=${_s}"; doneconfigure theme
$ cat ~/.cht.sh/cht.sh.conf CHTSH_QUERY_OPTIONS="style=arduino"themes
- algol_nu
- arduino
- native
- solarized-dark
- stata-dark
mode
[!NOTE|label:references:]
- path :
~/.cht.sh/mode
$ cht.sh --mode lite # use https://cheat.sh/ only
$ cht.sh --mode auto # use local installation
--shell
[!NOTE|label:references:]
$ brew install --HEAD rlwrap
$ cht.sh --shell python
cheat
[!NOTE|label:references:]
$ brew install cheat
configure
$ mkdir -p ~/.config/cheat && cheat --init > ~/.config/cheat/conf.yml
# -- config path --
$ cheat --conf
- reset cheatsheets repo
$ cd ~/.config/cheat/cheatsheets $ rm -rf community $ git clone https://github.com/cheat/cheatsheets.git community
theme
- arduino
- github-dark
- gruvbox
- native
onedark
optional
- doom-one
- evergarden
- lovelace
- nord
- solarized-dark256
- vulcan