tldr-python-client

Python命令行客户端tldr页面。

安装

检查Repology打包状态！

从PyPI安装

pip install tldr

来自Arch Linux仓库

sudo pacman -S tldr

来自Fedora软件包仓库

sudo dnf install tldr

来自Snap商店

sudo snap install tldr

使用方法

usage: tldr command [options]

Python command line client for tldr

positional arguments:
  command               command to lookup

options:
  -h, --help            show this help message and exit
  -v, --version         show program's version number and exit
  --search "KEYWORDS"   Search for a specific command from a query
  -u, --update, --update_cache
                        Update the local cache of pages and exit
  -p PLATFORM, --platform PLATFORM
                        Override the operating system [android, freebsd, linux, netbsd, openbsd, osx, sunos, windows, common]
  -l, --list            List all available commands for operating system
  -s SOURCE, --source SOURCE
                        Override the default page source
  -c, --color           Override color stripping
  -r, --render          Render local markdown files
  -L LANGUAGE, --language LANGUAGE
                        Override the default language
  -m, --markdown        Just print the plain page file.
  --print-completion {bash,zsh,tcsh}
                        print shell completion script

配置

您可以通过设置环境变量来配置tldr客户端的行为和输出。例如，在.bashrc文件中

export TLDR_COLOR_NAME="cyan"
export TLDR_COLOR_DESCRIPTION="white"
export TLDR_COLOR_EXAMPLE="green"
export TLDR_COLOR_COMMAND="red"
export TLDR_COLOR_PARAMETER="white"
export TLDR_LANGUAGE="es"
export TLDR_CACHE_ENABLED=1
export TLDR_CACHE_MAX_AGE=720
export TLDR_PAGES_SOURCE_LOCATION="https://raw.githubusercontent.com/tldr-pages/tldr/main/pages"
export TLDR_DOWNLOAD_CACHE_LOCATION="https://tldr-pages.github.io/assets/tldr.zip"

缓存

缓存从TLDR_DOWNLOAD_CACHE_LOCATION（默认值为客户端规范中描述的一个）下载，解压并提取到本地缓存目录中。如果使用tldr <command>，则直接从TLDR_PAGES_SOURCE_LOCATION加载页面。

• TLDR_CACHE_ENABLED（默认为1）
  • 如果设置为1，客户端将首先尝试从缓存中加载，如果缓存不存在或过旧，则回退到从互联网获取。
  • 如果设置为0，客户端将从互联网获取，如果无法从互联网获取页面，则回退到缓存。
• TLDR_CACHE_MAX_AGE（默认为168小时，相当于一周）：当TLDR_CACHE_ENABLED设置为1时，缓存的最大年龄，以小时为单位。

缓存位置

按优先级顺序

• $XDG_CACHE_HOME/tldr
• $HOME/.cache/tldr
• ~/.cache/tldr

如果您在使用tldr时遇到问题，请在尝试其他措施之前考虑删除缓存文件。

自动补全

使用--print-completion参数进行自动补全需要shtab。

# bash
tldr --print-completion bash | sudo tee "$BASH_COMPLETION_COMPAT_DIR"/tldr
# zsh (it is recommended to check where zsh/site-functions directory is located)
## for macOS:
tldr --print-completion zsh | sudo tee /usr/local/share/zsh/site-functions/_tldr
## for Linux:
tldr --print-completion zsh | sudo tee /usr/share/zsh/site-functions/_tldr

有关其他安装方法和支持的shell的信息，请参阅shtab文档。

对于fish的自动补全，虽然目前shtab还不支持，但请参阅#183，了解如何手动为fish添加tldr的自动补全。

SSL检查

对于位于代理后面的网络，可能需要禁用客户端的SSL验证才能正常运行。设置以下内容

• TLDR_ALLOW_INSECURE=1

将禁用SSL证书检查。此操作应避免，除非绝对必要。

颜色

TLDR_COLOR_x变量的值可以由三部分组成

• 字体颜色：blue, green, yellow, cyan, magenta, white, grey, red
• 背景颜色：on_blue, on_cyan, on_magenta, on_white, on_grey, on_yellow, on_red, on_green
• 附加效果，取决于平台：reverse, blink, dark, concealed, underline, bold

您可以指定任意多的附加效果，同时只能指定字体颜色和背景颜色中的一个。

上述任何值都可以省略。例如，您可以执行类似以下操作

• TLDR_COLOR_NAME=""使用默认系统字体颜色和默认背景颜色，没有任何效果
• TLDR_COLOR_DESCRIPTION="white"用于在默认系统背景颜色上显示白色文本，没有任何效果
• TLDR_COLOR_NAME="cyan dark"用于在默认系统背景颜色上显示深青色文本
• TLDR_COLOR_NAME="on_red"用于在红色背景上显示默认系统字体颜色
• TLDR_COLOR_PARAMETER="red on_yellow underline"用于在黄色背景上显示带下划线的红色文本
• TLDR_COLOR_NAME="bold underline"用于具有下划线和加粗效果的默认系统字体和背景颜色

语言

tldr所使用的语言取决于多个因素。如果您通过--language标志指定了语言，tldr将尝试使用该语言，且仅使用该语言。否则，它将尝试使用TLDR_LANGUAGE指定的语言。如果没有设置，或者该页面不存在于该语言中，则tldr将使用通过LANGUAGE和LANG设置的默认语言（忽略C和POSIX的值）。

如果这两个都没有设置，则tldr将始终尝试获取en页面。最后，如果设置了LANG，则它首先使用（如果设置了）LANGUAGE作为尝试语言优先级的列表，然后是（如果不在LANGUAGE中）LANG，最后是作为后备的en（假设它尚未出现在LANGUAGE或LANG中）。

所有语言值都应该设置为遵循RFC 1766的值，特殊例外是C和POSIX，这些将被忽略。

远程源

如果您希望使用自己的tldr页面实例而不是默认仓库，您可以在使用tldr时使用--source标志，或者通过指定以下环境变量

• TLDR_PAGES_SOURCE_LOCATION来控制从哪里获取单个页面。
  • 默认为https://raw.githubusercontent.com/tldr-pages/tldr/main/pages。
  • 它也可以指向一个本地目录，使用file:///path/to/directory。
• TLDR_DOWNLOAD_CACHE_LOCATION来控制从哪里拉取所有页面的zip文件。
  • 默认为https://github.com/tldr-pages/tldr/releases/latest/download/tldr.zip。