Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/tldr-pages/tldr/llms.txt

Use this file to discover all available pages before exploring further.

All contributions to the tldr-pages project are most welcome. Whether you want to add a brand-new command page, improve an existing one, fix a typo, translate pages into your language, or tackle a page requested by the community — every contribution helps make the project better for everyone.
Do not use generative AI tools (LLMs) to create or edit tldr pages. The project strongly discourages this practice, as AI-generated output is often inaccurate and frequently fails to follow the style guidelines. For translations, machine translation tools may be used as a reference only — their output must be thoroughly proofread before submission. Pull requests suspected of being made in whole or in part through generative AI or machine translation software without human review will be closed.

​
Ways to contribute

Add a new page

Write a tldr page for a command that doesn’t have one yet. Place it in the appropriate pages/<platform>/ directory and follow the page format guide.

Improve an existing page

Fix typos, improve descriptions, add missing examples, or update outdated information on any existing page.

Translate a page

Translate English pages into one of the 40+ supported languages. Pages live in pages.<locale>/ directories alongside the English source.

Fix a requested page

Browse open issues labelled help wanted on GitHub to find commands the community has specifically requested.

​
Before you start

  • Sign the Contributor License Agreement (CLA) at https://cla-assistant.io/tldr-pages/tldr. Your PR cannot be merged without it.
  • Check for existing PRs. Search the open pull requests to make sure nobody else is already working on the same command.
  • Base your PR against the main branch. All new page and improvement pull requests should target main.

​
Contribution workflow

1

Fork and clone the repository

Fork the tldr-pages/tldr repository on GitHub, then clone your fork locally:
git clone https://github.com/<your-username>/tldr.git
cd tldr
2

Create or edit the relevant Markdown file

tldr pages are plain Markdown files stored under pages/<platform>/. For example, a command available on all platforms belongs in pages/common/, while a Linux-only command belongs in pages/linux/:
# Create a new page
touch pages/common/my-command.md

# Or edit an existing page
nano pages/common/tar.md
Refer to the page format guide for the exact Markdown structure required.
3

Lint your page with tldr-lint

Install tldr-lint (requires Node.js) and run it against your page to catch formatting issues before submitting:
npm install --global tldr-lint
tldr-lint pages/common/my-command.md
4

Submit a pull request

Commit your changes using the correct commit message format (see below), push to your fork, and open a pull request against the main branch of tldr-pages/tldr. See the full submitting a PR guide for details.

​
Commit message format

Every commit (and the PR title) for page changes must follow this format: 
{{command}}: type of change
Where {{command}} is the name of the command being modified. Here are real examples drawn from the project:
ScenarioExample commit message
New page additionls: add page
Alias page additiondocker-container-rm: add alias page
Fix a typocat: fix typo
Add an examplegit-push: add --force example
New translationcp: add Tamil translation
Fix a translationcp: fix typo in Tamil translation
Multiple related pagesgrep, find, locate: synchronize format of wildcards
Multiple pages (glob)pages*: fix Linux casing
Multiple subcommand pagesgit-{add, push, ...}: add page
All pages in a languagepages.<locale>/*: update pages
For changes to scripts rather than pages, use scripts/{{script_name}}: description. For everything else, follow the Conventional Commits specification where possible.
Ready to dive deeper? Read the Style Guide to understand the writing rules for descriptions and examples, or the Page Format reference for the exact Markdown structure every tldr page must follow.

Build docs developers (and LLMs) love

Get started for freeTalk to us