CLI开发工具【免费下载链接】tealdeerA very fast implementation of tldr in Rust.项目地址https://gitcode.com/gh_mirrors/te/tealdeer点击查看免费下载tealdeer本项目是一款用 Rust 实现的 tldr 客户端它把 tldr-pages 仓库的速查页面缓存到本地并高速渲染。本指南聚焦于 tealdeer 内置在二进制中的tldr页面即 pages/tealdeer.md它集中展示了 tealdeer 区别于通用 tldr 规范的专属能力本地文件渲染、原始 Markdown 输出、路径与配置管理、自定义页面编辑以及缓存维护。读完本文你将能熟练使用这 9 个命令并结合源码理解它们的执行链路与命名约定。这个内置页面是什么在 tealdeer 中tldr tldr或tldr tealdeer显示的并不是从网络缓存中读取的内容而是编译时直接嵌入二进制的页面。在 src/main.rs 中可以看到static TEALDEER_PAGE: str include_str!(concat!(env!(CARGO_MANIFEST_DIR), /pages/tealdeer.md));当用户查询的命令恰好是tealdeer时程序直接渲染这份内嵌的 Markdown见 src/main.rs完全不需要缓存目录存在。命令名在查找前会统一转小写并按-连接src/main.rs所以tldr tldr与tldr tealdeer是等价的。页面开头也明确提示This page shows tealdeer specific functionality. See tldr tldr for more examples.9 个管理命令总览内置页面共给出 9 个 tealdeer 专属命令全部以--长选项形式出现参数解析定义在 src/cli.rs 的Cli结构体中命令作用定义位置tldr --render file把本地 Markdown 文件按 tldr 页面渲染src/cli.rstldr --raw command显示页面的原始 Markdown 源码src/cli.rstldr --show-paths显示 tealdeer 使用的文件与目录路径src/cli.rstldr --seed-config生成一份初始配置文件src/cli.rstldr --config-path FILE覆盖配置文件位置src/cli.rstldr --edit-page command在$EDITOR中打开自定义页面不存在则创建src/cli.rstldr --edit-patch command在$EDITOR中打开自定义补丁追加到已有页面src/cli.rstldr --clear-cache清空本地缓存src/cli.rstldr --no-auto-update本次运行禁用已配置的自动更新src/cli.rs渲染与原始输出--render把任意 Markdown 当 tldr 页面渲染tldr --render {{path/to/file.md}}该选项接收一个文件路径value_name FILE并通过ArgGroup::new(command_or_file)与位置参数command互斥src/cli.rs。其执行逻辑位于 src/main.rsif let Some(file) args.render { let reader PageLookupResult::with_page(file).reader()?; print_page(reader, args.raw, enable_styles, args.pager, config)?; return Ok(ExitCode::SUCCESS); }它把本地文件包装成PageLookupResult后走与缓存页面完全相同的渲染管线print_page定义于 src/output.rs这意味着标题、描述、示例代码的配色、缩进等样式配置对本地文件同样生效。典型用法先用编辑器写好一个自定义页面预览渲染效果再发布或者快速验证一个补丁文件的显示结果。--raw跳过渲染输出原始 Markdowntldr --raw {{command}}--raw短选项-r要求同时提供command或--render文件requires command_or_file。在 src/output.rs 中print_page会根据enable_markdown参数决定输出原始行还是高亮渲染。对于缓存页面它会输出该命令对应的.md源文件内容配合--render使用则直接打印本地文件原文。这对排查页面格式问题、或把原始 Markdown 交给其他工具处理很有用。路径与配置管理--show-paths查看所有关键路径tldr --show-paths该命令打印五类路径及其来源实现在 src/main.rsConfig dir配置文件所在目录Linux 上默认为~/.config/tealdeer/遵循 XDG 约定可用TEALDEER_CONFIG_DIR环境变量覆盖见 src/config.rsConfig path配置文件路径即config.toml见CONFIG_FILE_NAME常量src/config.rsCache dir缓存根目录Pages dir下载的页面所在目录缓存目录下的tldr-pages子目录见 src/cache.rsCustom pages dir自定义页面目录未配置时显示[None]。输出中每个路径后的括号标注了来源OS convention系统约定、env variable环境变量、config file配置文件或command line argument命令行参数对应PathSource枚举src/types.rs。首次安装后运行该命令可以立刻确认文件都落在哪里。--seed-config一键生成初始配置tldr --seed-config该命令在配置目录下生成一份完整的默认config.tomlsrc/config.rs。源码保证了两个安全行为若配置文件已存在则拒绝覆盖并报错若配置目录不存在则自动创建。生成的默认配置自带预置样式——例如example_text前景色为绿色、command_name与example_code为青色、example_variable为青色加下划线src/config.rs这些默认值由RawConfig::default()序列化而来可作为后续自定义的起点。--config-path指定非默认位置的配置文件tldr --config-path FILE默认情况下ConfigLoader::read_default_path会读取默认位置文件不存在时静默回退到内置默认配置src/config.rs。传入--config-path后程序改为从指定路径强制读取src/main.rs路径不存在会直接报错。该选项便于在 CI、测试或便携场景下携带独立配置配合--override-config如updates.auto_update true可以在不改动配置文件的情况下临时覆盖任意 TOML 键值实现见 src/config.rs。自定义页面与补丁的编辑工作流--edit-page创建或编辑自定义页面tldr --edit-page {{command}}该选项要求同时给出commandrequires command。执行时会在自定义页面目录下打开不存在则创建command.page.md文件并调用$EDITOR环境变量指定的编辑器src/main.rs。若EDITOR未设置程序会明确报错提示To edit a custom page, please set theEDITORenvironment variable.自定义页面目录默认遵循系统约定Linux 上通常为~/.local/share/tealdeer/pages/详见 docs/src/usage_custom_pages.md可通过directories.custom_pages_dir配置项或--show-paths确认。自定义页面会完全取代缓存中的同名上游页面。--edit-patch以补丁方式扩展现有页面tldr --edit-patch {{command}}与--edit-page互斥conflicts_with edit_page它打开的是command.patch.md文件。补丁与页面不同页面是替换补丁是追加。在 src/cache.rs 的find_page中查找顺序为自定义页面.page.md→ 补丁文件.patch.md→ 缓存页面而PageLookupResult::reader()src/cache.rs会把页面文件与补丁文件按顺序拼接读取效果上等效于页面原文 换行 补丁内容。仓库的测试目录 tests/custom-pages/inkscape-v2.patch.md 正是一个真实补丁示例对应渲染断言可参见 tests/rendered/ 下的inkscape-patched-no-color.expected。命名约定与版本提示tealdeer 1.7.0 起自定义文件命名从name.page/name.patch迁移为name.page.md/name.patch.md。程序仍会检测旧命名文件并提示重命名src/main.rs但--edit-page/--edit-patch始终使用新约定。缓存维护--clear-cache清空本地页面缓存tldr --clear-cache实现上直接删除pages_directorytldr-pages目录并打印成功信息clear_cache函数见 src/main.rs底层删除逻辑见 src/cache.rs。配合--quiet可静默执行。清空后下一次需要读取页面时需重新执行tldr --update下载src/main.rs 会给出明确的缓存缺失提示与建议。--no-auto-update本次运行跳过自动更新tldr --no-auto-update若配置文件中启用了updates.auto_update true每次运行 tldr 时都会在缓存过旧默认 30 天MAX_CACHE_AGE见 src/config.rs时自动更新。该选项用于单次抑制这一行为判断逻辑在 src/main.rslet cache if args.update || config.updates.auto_update !args.no_auto_update {即显式--update或自动更新已开启且本次未用--no-auto-update关闭时才触发更新流程。适合在离线环境、批量脚本或演示场景下避免意外的网络请求。组合使用与进一步阅读这 9 个命令可以灵活组合例如tldr --show-paths确认目录 →tldr --seed-config生成配置 →tldr --edit-page tar编写自定义页面 →tldr --render ~/.local/share/tealdeer/pages/tar.page.md预览 →tldr --edit-patch tar补充补丁 →tldr tar验证最终渲染。相关资源完整 CLI 帮助输出见 docs/src/usage.txt页面集成方式见 docs/src/usage.md自定义页面与补丁的详细规范见 docs/src/usage_custom_pages.md配置项display、updates、directories、search、style五大节说明见 docs/src/config.md命令行参数解析源码 src/cli.rs、主流程 src/main.rs、缓存实现 src/cache.rs。上述命令均基于 tealdeer 1.8.1 的 Cargo.toml 版本与 src/cli.rs 的实际参数定义编写可直接复制运行若你的安装版本较新请以tldr --help的输出为准。赞分享CLI开发工具【免费下载链接】tealdeerA very fast implementation of tldr in Rust.项目地址https://gitcode.com/gh_mirrors/te/tealdeer点击查看免费下载相关推荐tldr 别名页实战解析Linux edit 命令与 run-mailcap --actionedittldr 别名页实战解析Linux edit 命令与 run mailcap actionedit 本篇技术指南以 tldr 仓库中的保加利亚语别名页 pa文档教程知识库Termux pkg 包管理命令实战指南tldr 速查页 pages.bn/android/pkg.md 全解析Termux pkg 包管理命令实战指南tldr 速查页 pages.bn/android/pkg.md 全解析 pkg 是 TermuxAndroid 终文档教程知识库tldr 俄语页面编写规范实战指南从页面结构、命令式措辞到 tldr-lint 校验tldr 俄语页面编写规范实战指南从页面结构、命令式措辞到 tldr lint 校验 本指南以 tldr 仓库的 style guide.ru.md http文档教程知识库上一篇没有真实设备用OpenModScan内置数据模拟器一键完成Modbus轮询测试下一篇AI Engineer Coach测试体系Vitest单元测试Playwright端到端测试实践创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考