tldr vs navi

tldr vs navi: tldr shows example-based help pages for commands; navi is a fuzzy-search cheatsheet launcher that runs snippets you write.

Updated

short verdict

Pick tldr if you want to look up how a command is used and read a few examples, via `tldr tar` and a client in Python, Rust or Node.js. Pick navi if you want to search your own snippets in a fuzzy-finder menu, fill in arguments from suggested values, and run the result. They overlap little, and navi can integrate with tldr.

Both tools reduce the need to memorize command-line syntax, but they solve different problems. tldr is a community-maintained collection of simplified help pages, written in Markdown and read through official clients. navi is a Rust program that turns cheatsheet files into a fuzzy-searchable menu and executes the command you pick.

this page is for

  • Developers who want quick examples instead of full man pages
  • Users who keep a personal set of one-liners and want to run them interactively
  • Teams sharing command snippets through Git repositories
pick

tldr

★ 64.1kMarkdown
details

Better pick when you want a read-only reference of common usage examples for thousands of existing commands.

best for

  • Looking up common flags for tar-style commands
  • Reading examples on Unix, Linux, macOS or Windows commands

strengths

  • Query by command name, for example `tldr tar`, and get concise examples
  • Official clients in Python, Rust and Node.js, plus a web interface
  • Community translations cover multiple languages
  • Pages are Markdown in a GitHub repo, so contributing is a pull request

weaknesses

  • Shows examples only; it does not execute commands or fill in arguments
  • Content is limited to what the community has written for each command
pick

navi

★ 17.8kRust
details

Better pick when you want to search, parameterize and run your own or shared command snippets from the terminal.

best for

  • Running complex one-liners without retyping them
  • Shell widget use similar to Ctrl-R history search

strengths

  • Fuzzy-search menu with execution of the selected command
  • Argument values are suggested in a list and can come from command output
  • Write custom `.cheat` files, import Git repositories, or download community cheatsheets
  • Shell widget, a terminal-multiplexer widget for SSH sessions, and scripting modes

weaknesses

  • Needs cheatsheets to be downloaded or written before it is useful
  • Needs a separately installed fuzzy finder for its menu
  • Not a reference for arbitrary commands unless you add a source such as tldr

Key differences

  • Scope: tldr is a help-page reference; navi is a snippet launcher that executes commands
  • Interface: tldr prints a page for `tldr <command>`; navi opens a fuzzy-search menu
  • Content format: tldr pages are Markdown; navi cheatsheets are `.cheat` files with variable substitution
  • Language: tldr is Markdown (clients in Python, Rust, Node.js); navi is Rust
  • License: tldr is MIT; navi is Apache-2.0
  • Integration: navi can use tldr as a cheatsheet source; tldr documents no equivalent integration

Choose tldr when

  • You want example-based help for a command you rarely use
  • You prefer a client in Python, Rust or Node.js, or a web interface
  • You need pages in a language other than English through community translations
  • You want to contribute pages through GitHub in Markdown

Choose navi when

  • You keep personal one-liners and want to run them from a fuzzy menu
  • You want argument values suggested from a list or command output
  • You want a Ctrl-R style shell widget, or a terminal-multiplexer widget for SSH sessions
  • You want to share cheatsheets through Git repositories with auto-updating

When not to use these

  • You need full option-by-option documentation, where man pages are the reference
  • You only want a plain history search for commands you already ran

FAQ

Can I use tldr and navi together?
Yes. navi integrates with tldr, so you can use navi as the interactive front end and tldr as a content source.
Which is faster, tldr or navi?
Neither project documents performance figures, so there is no stated speed comparison. They also do different jobs: tldr prints a page, while navi opens an interactive menu.
Which is easier to configure?
tldr needs no configuration to query a command after installing a client. navi documents customization for colors, column sizing and search behavior, and uses `.cheat` files for your own snippets.
Which has more install options?
tldr documents installs through pipx, Homebrew (tlrc), Cargo and npm. navi documents Homebrew installation.

related