shell小工具推荐——tldr

tldr使用效果

今天偶然发现了一个宝藏shell工具，推荐linux，macos用户使用：tldr

在使用man手册查询命令的功能时候，往往会出现一大堆参数，如下:

$ man ls


LS(1)                            User Commands                           LS(1)

NAME
       ls - list directory contents

SYNOPSIS
       ls [OPTION]... [FILE]...

DESCRIPTION
       List  information  about  the FILEs (the current directory by default).
       Sort entries alphabetically if none of -cftuvSUX nor --sort  is  speci‐
       fied.

       Mandatory  arguments  to  long  options are mandatory for short options
       too.

       -a, --all
              do not ignore entries starting with .

       -A, --almost-all
              do not list implied . and ..

       --author
              with -l, print the author of each file

       -b, --escape
              print C-style escapes for nongraphic characters

       --block-size=SIZE
              with  -l,  scale  sizes  by  SIZE  when  printing  them;   e.g.,
              '--block-size=M'; see SIZE format below

       -B, --ignore-backups
              do not list implied entries ending with ~

       -c     with -lt: sort by, and show, ctime (time of last modification of
              file status information); with -l: show ctime and sort by  name;
              otherwise: sort by ctime, newest first

       -C     list entries by columns

       --color[=WHEN]
              colorize  the output; WHEN can be 'always' (default if omitted),
              'auto', or 'never'; more info below

       -d, --directory

我们有时候需要快速的使用这个命令，而不希望需要查阅这么多的资料，这时候tldr工具就来了，使用效果如下：

$ tldr ls


ls

  列出目录中的内容。
  更多信息：https://www.gnu.org/software/coreutils/ls.

  - 列出目录中的文件，每个文件占一行：
    ls -1

  - 列出包含隐藏文件的所有文件：
    ls -a

  - 列出所有文件，如果是目录，则在目录名后面加上「/」：
    ls -F

  - 列出包含隐藏文件的所有文件信息，包括权限，所有者，大小和修改日期：
    ls -la

  - 列出所有文件信息，大小用人类可读的单位表示（KiB, MiB, GiB）：
    ls -lh

  - 列出所有文件信息，按大小降序排序：
    ls -lSR

  - 列出所有文件信息，按修改日期从旧到新排序：
    ls -ltr

  - 只列出目录：
    ls -d */

tldr+命令可以快速且简短的给出使用说明，很节省时间。

tldr安装

tldr：全称是：too long，don`t read,就是为了简短的显示命令的使用方式，以下是ubuntu下的安装方法。

sudo apt install tldr

以上方法被舍弃的原因是更新太麻烦了，tldr --update经常卡住，所以我们选择一种新的方法安装。

tealdeer代替node.js安装

# 卸载npm安装的tldr
npm uninstall -g tldr
# 安装tealdeer
sudo apt update
sudo apt install tealdeer

手动配置配置文件

需要我们手动创建配置文件

# 创建新的目录
mkdir -p ~/.config/tealdeer
# 创建配置文件
touch ~/.config/tealdeer/config.toml

配置文件内容如下：

# tealdeer 配置文件 (~/.config/tealdeer/config.toml)

[display]
# 设置显示语言为中文
language = "zh"

# 启用彩色输出（auto = 根据终端自动判断，always = 总是彩色，never = 禁用彩色）
use_color = "auto"

# 是否显示命令示例前的标题（比如 "Examples"）
show_headers = true

# 是否显示超链接（有的命令会带参考链接）
hyperlinks = true

[updates]
# 自动更新启用
auto_update = true

# 自动更新的时间间隔（单位：小时）
# 这里设置为 168 小时 = 7 天
auto_update_interval_hours = 168

汉化

前提是你安装了nodejs和npm,安装tldr客户端
sudo npm install -g tldr
设置语言环境为中文，修改系统变量

首先查看终端语言环境和系统默认语言环境：

locale
echo $LANG

如果显示如下

locale
LANG=en_US.UTF-8
LANGUAGE=en_US.UTF-8
LC_CTYPE="en_US.UTF-8"
LC_NUMERIC="en_US.UTF-8"
LC_TIME="en_US.UTF-8"
LC_COLLATE="en_US.UTF-8"
LC_MONETARY="en_US.UTF-8"
LC_MESSAGES="en_US.UTF-8"
LC_PAPER="en_US.UTF-8"
LC_NAME="en_US.UTF-8"
LC_ADDRESS="en_US.UTF-8"
LC_TELEPHONE="en_US.UTF-8"
LC_MEASUREMENT="en_US.UTF-8"
LC_IDENTIFICATION="en_US.UTF-8"
LC_ALL=en_US.UTF-8

echo $LANG
en_US.UTF-8

则表明终端语言环境（LANG）和系统语言环境（LC_ALL）均为英文，我们需要修改终端语言环境如下：

vim ~/.bashrc

在文件末尾添加：

export TLDR_LANG=zh
export TLDR_LANGUAGE=zh_Hans
export LANG=zh_CN.UTF-8
export TEALDEER_LANGUAGE=zh
export LANGUAGE=zh_CN:zh
unset LC_All #仅仅修改终端让其不生效

最后更新一下是更改生效：

source ~/.bashrc

更新tldr缓存

tldr --update
tldr ls # 查看一下成果吧

接下来就可以愉快使用啦！

• 本文作者： 迪丽惹Bug
• 本文链接： https://lyroom.github.io/2024/10/14/shell小工具推荐——tldr/
• 版权声明： 本博客所有文章除特别声明外，均采用 MIT 许可协议。转载请注明出处！