Don’t read the docs (of an CLI tool) without trying
Tools
tldr
tldr-pages
1: Simplified and community-driven man
pages
tldr-pages
for a CLI tool can be available for many platforms, e.g. common
, linux
, osx
, windows
, …
tldr-pages
can be accessed in a lot of ways2:
- Via a PWA: tldr.inbrowser.app
- Via a Browser extension: piraces/tldr-extension-browser
- Via a CLI tool:
- tldr-c-client: The original client, written in C
- tldr-python-client: Python command-line client for tldr pages (This one is distributed for Linux distros)
- tlrc: A new official tldr client written in Rust
- As a PDF ebook in many languages3
tldr
(tl;dr
)
: short for too long; didn't read
(also occasionally don't read
)
: (internet slang) used to introduce a summary of an online post or news article4
cheat
cheat5: cheatsheats for *nix
commands that are used frequently, but not frequently enough to be remembered
xny
xny6: A way to use Learn X in Y Minutes on the command line.
Terminal/shell completion feature
Warp’s completion
zsh completion
zsh completion with fuzzy search
fish completion
The new terminal of JetBrain’s IDEs (e.g. GoLand)
For more information, see its Introduce Blog