tealdeer-rs/tealdeer

Tealdeer is a command-line interface tool designed to fetch and display simplified man pages (tldr) for various commands. It features a modular architecture that handles caching, configuration via TOML, and rendering of page content with syntax highlighting and optional pager support. The system supports multiple shell environments through completion scripts and manages updates and custom pages robustly.

This change introduces the foundational repository structure for tealdeer, including the primary README with installation and usage instructions, the CHANGELOG documenting version history, and the dual MIT/Apache-2.0 license files. It also adds developer configuration files such as .editorconfig and .gitattributes to enforce consistent code formatting and line endings, along with a .readthedocs.yaml file to configure automated documentation builds.

(repo-wide) · high confidence

Added two new shell scripts to the project's CI tooling: \scripts/get-mdbook.sh\ downloads and verifies mdBook v0.5.4 with SHA-256 checksum validation, and \scripts/upload-asset.sh\ provides functions to create GitHub releases and upload artifacts via the GitHub API. These scripts support the automated documentation build and release workflow.

scripts · high confidence

The tealdeer CLI now provides dedicated shell completion scripts for Bash, Fish, and Zsh, enabling tab-completion for commands, flags, and cached entries. These scripts support the full set of current options, including platform overrides (such as Android and BSD variants), configuration flags like --override-config and --no-auto-update, and dynamic listing of available tldr pages.

completion · high confidence

The application has been rewritten from the ground up, replacing the previous monolithic main.rs with a modular structure (cache, cli, config, formatter, line\_iterator, output, types, utils). The CLI now uses clap for argument parsing, supporting new flags like --render, --edit-page, and --pager. The cache system has been completely redesigned to handle page lookups, updates, and custom pages more robustly. The formatter now supports a new tldr page format (V2) alongside the old V1, with improved syntax highlighting and placeholder handling. The output module handles printing with optional pager support and styled output using yansi. Configuration is now loaded via a dedicated config module with TOML support. The types module defines platform detection, color options, and line types. Utility functions for warnings and errors are centralized. This rewrite significantly improves code maintainability, performance, and feature set.

src · high confidence

Add rendered output tests for apt, inkscape, and playerctl; Added integration test infrastructure and style configuration.

The project has been updated to use the Rust 2024 edition and raises the Minimum Supported Rust Version (MSRV) to 1.88. Core dependencies have been upgraded, including switching the HTTP client from reqwest to ureq (v3.0.8) with rustls for TLS, updating the argument parser to clap v4.6.6, and upgrading the TOML parser to v1. The package name has also been changed from 'tldr' to 'tealdeer'.

(dependencies) · high confidence

Written by watchdog.canine.dev from the codebase's own history, inside the signed delivery this page is composed from.

• CAI 66 → 68 (+1.3)
• Rubric changed (rubric-2026.09.9 → rubric-2026.09.18) — scores are not directly comparable.

• Code Health 93 → 93 (+0.0)
• Architecture 100 → 87 (-13.2)
• Maturity 55 → 55 (-0.0)
• Readiness 89 → 85 (-4.5)
• Security 58 → 72 (+13.7)

• Documentation: no installation or build instructions (README.md)

• Medium vulnerability: RUSTSEC-2026-0285 (Cargo.lock)
• Outdated: clap
• Outdated: log
• Outdated: toml
• Outdated: ureq

Written by watchdog.canine.dev from the codebase's own history, inside the signed delivery this page is composed from.

tealdeer-rs/tealdeer was measured the same way every project in this corpus was: the same rubric, at a pinned commit, with the result published in full. Point a surveyor at a repository you know and see whether you agree with it.