tldr 使用教程：安装、中文配置与命令示例

什么是tldr？

一个命令帮助手册，快速查看命令的使用方法，这个工具会直接给出多个使用示例，可以覆盖大部分场景，对于新手来说非常友好。

安装

在windows,linux,macos操作系统都可以安装使用，如果要使用中文版本，推荐使用pipx安装

pipx安装

pipx install tldr

npm安装

npm install -g tldr

macOS使用brew安装

brew install tldr

配置中文

环境变量说明：

tldr 可以通过配置环境变量完成语言切换、切换下载源、缓存功能，另外，如果通过 pipx 安装，还会涉及 PATH 等环境变量的配置。下面重点讲几个环境变量

• TLDR_LANGUAGE：设置tldr的语言，默认是英文，设置为zh后，tldr会显示中文文档。
• TLDR_CACHE_ENABLED：是否优先使用本地缓存，默认开启（1）；设为 0 则优先从网络拉取。
• TLDR_CACHE_MAX_AGE：设置缓存的最大有效期。
• TLDR_DOWNLOAD_CACHE_LOCATION：设置tldr下载缓存的地址。
• TLDR_PAGES_SOURCE_LOCATION：设置tldr页面源的地址。
• PATH：命令搜索路径，需包含 tldr 可执行文件所在目录（pipx 安装为 ~/.local/bin）。

tldr 的各种语言的翻译文档都存储在 https://github.com/tldr-pages/tldr ，下载时可能遇到网络问题，导致下载失败，可以手动下载完成后放在 tldr 的缓存目录中，在Linux / macOS 中，缓存目录为 ~/.cache/tldr/pages

windows平台

setx TLDR_LANGUAGE "zh"
setx TLDR_CACHE_ENABLED "1"
setx TLDR_CACHE_MAX_AGE "876000"
setx TLDR_DOWNLOAD_CACHE_LOCATION "https://gh-proxy.org/https://github.com/tldr-pages/tldr/releases/latest/download/tldr.zip"
setx TLDR_PAGES_SOURCE_LOCATION "https://gh-proxy.org/https://raw.githubusercontent.com/tldr-pages/tldr/main/pages"

linux/macOS平台，对于不同的shell，配置环境变量的方式不同，需要先确定你当前使用的 shell 类型

echo $SHELL

如果是bash，配置环境变量到~/.bashrc文件中

# 追加环境变量到~/.bashrc文件中
echo 'export TLDR_LANGUAGE="zh"' >> ~/.bashrc
echo 'export TLDR_CACHE_ENABLED=1' >> ~/.bashrc
echo 'export TLDR_CACHE_MAX_AGE=876000' >> ~/.bashrc
echo 'export TLDR_DOWNLOAD_CACHE_LOCATION="https://gh-proxy.org/https://github.com/tldr-pages/tldr/releases/latest/download/tldr.zip"' >> ~/.bashrc
echo 'export TLDR_PAGES_SOURCE_LOCATION="https://gh-proxy.org/https://raw.githubusercontent.com/tldr-pages/tldr/main/pages"' >> ~/.bashrc
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
# 生效
source ~/.bashrc

如果是zsh，配置环境变量到~/.zshrc文件中

# 追加环境变量到~/.zshrc文件中
echo 'export TLDR_LANGUAGE="zh"' >> ~/.zshrc
echo 'export TLDR_CACHE_ENABLED=1' >> ~/.zshrc
echo 'export TLDR_CACHE_MAX_AGE=876000' >> ~/.zshrc
echo 'export TLDR_DOWNLOAD_CACHE_LOCATION="https://gh-proxy.org/https://github.com/tldr-pages/tldr/releases/latest/download/tldr.zip"' >> ~/.zshrc
echo 'export TLDR_PAGES_SOURCE_LOCATION="https://gh-proxy.org/https://raw.githubusercontent.com/tldr-pages/tldr/main/pages"' >> ~/.zshrc
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.zshrc
# 生效
source ~/.zshrc

更新缓存文档

tldr -u

命令使用示例

tldr ls
tldr find

常见问题

Github第三方加速下载安全吗

不保证第三方加速下载的安全性和可信性，可以自行下载或使用代理下载

tldr 配置了中文， 还是显示英文？

1. 环境变量是否生效：Linux/macOS 执行 echo $TLDR_LANGUAGE，Windows 执行 echo %TLDR_LANGUAGE%，确认输出 zh；
2. 是否重开了终端（Windows 的 setx 只对新终端生效）；
3. 缓存是否更新：执行 tldr -u 重新拉取。

报错 tldr: command not found

一般是可执行文件不在 PATH 里。pipx 安装的路径是 ~/.local/bin。

下载很慢 / 卡住 / 更新失败

默认从 GitHub 下载，国内慢。按上文把 TLDR_DOWNLOAD_CACHE_LOCATION 配成镜像即可。若镜像域名失效，换成其它可用的：gh-proxy.com 、github.akams.cn等。

某些命令没有中文页面？

tldr 的中文翻译是社区贡献的，部分命令还没翻译，会回退到英文，属正常现象。

参考：

• tlrd 使用中文