TLDR(1)

📦 version 0.7.0, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

💖 TLDR(1) — the manual page for tldr, bestie edition 💖

okay so real talk, this is the manual page for the tldr command — and yes, it's the Python client for tldr. sit with me, we're gonna get through this together, it's gonna be iconic. 🎀

✨ NAME ✨

tldr — Python client for tldr. that's it, that's the name, she's simple and she knows it. 💅

✨ SYNOPSIS ✨

tldr [OPTIONS] COMMAND [ARGS]...

like, you give her some options, then a command, then whatever args that command wants. the vibes are structured. 🦋

✨ DESCRIPTION ✨

so. yet another Python client for tldr. yes bestie, another one, and honestly? we're not even mad. 💅

and if you're sitting there like "what even is tldr" — no worries, I got you: tldr is a collection of simplified and community-driven man pages. that's the whole point. community-driven, simplified, cute, digestible. it's giving "man pages but she went to therapy and learned to be concise." ✨

✨ OPTIONS ✨

  • -V, --version — shows the version and dips. that's it, that's the whole job. 👑
  • -h, --help — shows the help and dips. your lil emergency exit, use it whenever. 🫶

✨ COMMANDS ✨

  • find — find the command usage. you're looking for how a thing works, she's gonna go find it for you. 🔍
  • init — init config file. first-day-of-school energy, you gotta set yourself up. 🎀
  • reindex — rebuild the index. she's reorganizing her whole closet, let her cook. 🧚
  • update — update to the latest pages. fresh pages, fresh vibes, no cap. 🌸

✨ EXAMPLES ✨

🌈 Download tldr pages and init config

$ git clone git@github.com:tldr-pages/tldr.git ~/.tldr
$ tldr init
Input the tldr repo path(absolute path): /home/<user>/.tldr
Input your platform(linux, osx or sunos): linux
$ tldr reindex

so you clone the repo into ~/.tldr, you run tldr init, and then she asks you things — she wants the absolute path to your tldr repo (that's the /home/<user>/.tldr moment) and she wants your platform, and your options there are linux, osx or sunos. answer honestly. then tldr reindex to make it all make sense. ✨

💜 Update tldr pages

$ tldr update

boom. latest pages. periodt.

🦋 Show tar tldr page

$ tldr find tar

and there she is, the tar page, found for you like the main character she is. 👑

lowkey a reminder that the whole point of tldr is that these pages are simplified and community-driven — so they're short on purpose, not because someone got lazy. 💖

okay that's the whole page, we ate, no crumbs left. this lil beauty is the Python client for tldr, dated November 2017, and it lives under TLDR(1). mwah, go read some pages bestie 💋🌸💜

📦 where this page comes from