如何安裝 tldr pages:更新快取、閱讀簡化命令範例與 man 頁對照

安裝 tldr,更新快取,查命令範例,並知道何時仍用 man。

记不全 tar、ffmpeg 或 docker 的长选项时,man 页信息全但难扫;tldr pages 社区维护精简示例,客户端命令通常是 tldr。本教學涵蓋 macOS/Linux/Windows 安裝 tldr、用 tldr --update 更新本機快取、查命令範例,以及與 man/--help 的對照,面向 hereink 讀者常用的終端機工作流。

檢索詞是如何安裝 tldr pages 並更新快取查看命令範例。讀完應能安裝 tldr、刷新页面库、用 tldr git 这类命令读到可复制示例,并知道何时仍该打开 man。

安裝brew · npm · cargo
快取tldr --update
對照tldr vs man
安裝客户端--update查示例

tldr 解决什么问题

示例优先,不是手册全文

tldr tar 列出常见压缩/解压一行命令;man tar 则是完整选项说明。適合「我大概记得工具名,忘了 flags」的场景。

与 rg、bat 同一终端栈

查完 tldr kubectl 复制到脚本,再用站内 ripgrep、HTTPie 教程里的工具调试。tldr 不负责解释每个 flag 的语义边界。

页面库:github.com/tldr-pages/tldr,站点 tldr.sh。常见 Rust 客户端 tealdeer(二进制名 tldr);另有 Node、Python 客户端,命令名同为 tldr。

安裝 tldr 客户端

  1. 1
    macOS(Homebrew,tealdeer)

    brew install tealdeer。驗證:which tldr 与 tldr --version。Homebrew 也可能提供独立的 tldr formula,二者择一即可,避免 PATH 里两个同名命令冲突。

  2. 2
    Linux

    Arch:pacman -S tealdeer。Debian/Ubuntu 可从发行版包或 cargo install tealdeer 安裝。Fedora 等见 tldr.sh 的 Clients 列表。通用:npm install -g tldr(Node 客户端)。

  3. 3
    Windows

    scoop install tealdeer 或 choco install tealdeer;也可用 npm install -g tldr。新开终端后 tldr --version。

  4. 4
    首次拉取页面

    多数客户端首次查询会自动下载快取;也可手动 tldr --update(见下一节)。需要代理时按客户端文档设置 HTTP_PROXY 等。

用 tldr --update 更新快取

社区页面每日合并 PR;本地快取会过期。定期更新:

# 从 tldr-pages 仓库同步最新页面(各客户端命令相同)
tldr --update

# 查看快取位置(tealdeer 示例)
tldr --list
tldr --info

更新失败时检查网络、磁盘权限与 GitHub 可达性。公司代理环境需配置系统或环境变量代理;勿从不明来源下载第三方页面包。

阅读简化命令示例

# 基本查询
tldr tar
tldr git commit

# 指定平台(Linux / osx / windows 页面略有不同)
tldr --platform linux curl

# 列出已快取的命令
tldr --list | head

# 搜索相关页(部分客户端支持)
tldr -s archive

输出结构通常是:一行描述 + 若干「示例说明 + 命令行」。直接复制到终端前,先读注释里的占位符(如 path/to/file、host),避免误删生产数据。

tldr 与 man / --help 對照

目标tldrman / --help
常见用法速查tldr ffmpegman 需翻章节;--help 往往只有选项列表
完整选项与默认值通常不覆盖man 1 tar 或 tool --help
子命令差异各子命令常有独立页 tldr git checkoutman 一篇长文
离线更新后本地快取可读man 依赖系统 man-db
贡献示例向 tldr-pages 提 PR上游项目文档
適合
忘 flags、写 README 示例、SSH 到陌生服务器快速回忆命令、与 gh、jq 教程里的工具并列使用。
不適合
安全敏感参数(chmod、iptables)、需要精确语义的法律/合规场景——必须读官方 man 或文档再执行。
tldr 和 cheat 有什么区别?

cheat 偏个人/团队自定义速查 sheet;tldr pages 是社区统一格式的简短示例。两者可并存,查询入口不同。

提示 command not found in tldr?

运行 tldr --update;仍无则该命令可能尚未收录,可查阅 man 或到 github.com/tldr-pages/tldr 搜索。也可给社区提 PR 添加页面。

tealdeer 和 npm 的 tldr 选哪个?

tealdeer(Rust)启动快、快取清晰,macOS/Linux 常用。已深度使用 Node 全局工具链可用 npm i -g tldr。只保留一个 tldr 在 PATH 最前即可。

命令對齊後畫一張圖

部署步骤或服务边界仍適合摊在同一张白板上。见 如何建立空間。

立即開會