#1042·navi

fails the tldr integration with tealdeer (navi 2.24.0)

Author: hossam-houssienCreated Aug 22, 2026Updated Sep 14, 2026
Labelsbug

Describe the bug navi failed with --tldr although tealdeer in PATH and configured in config.yaml

To Reproduce

bash
navi --tldr ls
Hey, listen! navi encountered a problem.
Do you think this is a bug? File an issue at https://github.com/denisidoro/navi.

Caused by:
    Failed to call:
    tldr ls --markdown

    Output:


    Error:
    error: unexpected argument '--markdown' found

      tip: to pass '--markdown' as a value, use '-- --markdown'

    Usage: tldr [OPTIONS] [PAGE]...

    For more information, try '--help'.


    Note:
    The client.tealdeer config option can be set to enable tealdeer support.
    If you want to use another client, please make sure it supports the --markdown flag.
    If you are already using a supported version you can ignore this message.
    tldr-c-client (the default one in Homebrew) doesn't support markdown files, so navi can't use it.
    The recommended client is tealdeer(https://github.com/dbrgn/tealdeer).

Expected behavior it should use tealdeer and show ls cheatsheet

Versions:

  • OS: Microsoft Windows [Version 10.0.22631.5624]
  • Shell Version [cmd]

Additional context config.yaml

yaml
style:
  tag:
    color: cyan # text color. possible values: https://bit.ly/3gloNNI
    width_percentage: 26 # column width relative to the terminal window
    min_width: 20 # minimum column width as number of characters
  comment:
    color: blue
    width_percentage: 42
    min_width: 45
  snippet:
    color: white

finder:
  command: fzf # equivalent to the --finder option
  # overrides: --tac # equivalent to the --fzf-overrides option
  # overrides_var: --tac # equivalent to the --fzf-overrides-var option

  cheats:
#   paths:
#     - /path/to/some/dir # on unix-like os
#     - F:\\path\\to\\dir # on Windows
# path: /path/to/some/dir # (DEPRECATED) equivalent to the --path option

# search:
#   tags: git,!checkout # equivalent to the --tag-rules option

  client:
    tealdeer: True # enables tealdeer support for navi --tldr

shell:
  # Shell used for shell out. Possible values: bash, zsh, dash, ...
  # For Windows, use `cmd.exe` instead.
  command: cmd.exe