$devvkit learn --librarie tldr-&-cheat-guide

tldr & cheat Guide

[docs][cheatsheet][cli][learning]

Dev Productivity

Install

# tldr:
brew install tlrc
npm install -g tldr
pip install tldr

# cheat:
brew install cheat
go install github.com/cheat/cheat@latest
pip install cheat

tldr shows simplified, community-maintained man pages with practical examples. Instead of scrolling through 500-line man pages, `tldr tar` shows the 8 most common use cases with concise examples. It supports 500+ commands.

cheat lets you create and share personal cheat sheets. `cheat tar` shows your personal notes. `cheat -e tar` opens the cheatsheet in your editor. Sheets are stored in ~/.config/cheat/cheatsheets/ and support syntax highlighting.

Use tldr for learning new commands and cheat for remembering your own workflows. Both have dark/light themes. Run tldr --list to see available pages. The tldr client supports offline mode after initial sync.

tldr Basics

tldr view command— Show simplified docs.

tldr tar
tldr docker
tldr ffmpeg
tldr curl
tldr git log
tldr --search "compress"

tldr update cache— Refresh local pages.

tldr --update
tldr -u
tldr --list
tldr --language zh tar
# Set default language:
export TLDR_LANG="zh"

tldr Advanced

tldr rendering— Customize display.

tldr --color=always
tldr --quiet
export TLDR_CACHE_ENABLED=1

# Platform-specific:
tldr --platform linux tar
tldr --platform osx tar

cheat Basics

cheat view— Show personal cheatsheet.

cheat tar
cheat docker
cheat -l              # List all sheets
cheat -d              # List with descriptions
cheat -r              # Reverse sort

cheat create/edit— Write your own.

cheat -e git-branch
# Opens in $EDITOR:
# ---
# Create and switch:
#   git checkout -b feature-name
# Delete local branch:
#   git branch -d feature-name
# Delete remote branch:
#   git push origin --delete feature-name

cheat Config

cheat tags and search— Organize and find.

cheat -s docker        # Search sheets by text
cheat -t git           # Filter by tag
cheat -g               # Group by tag

# Config at ~/.config/cheat/conf.yml:
editor: nvim
colorize: true

cheat sheet path— Where sheets live.

# Default paths:
# ~/.config/cheat/cheatsheets/personal/
# /usr/share/cheat/cheatsheets/

# Add custom path in conf.yml:
cheatpaths:
  - name: work
    path: ~/work-cheats
    tags: [work]
    readonly: false