# tldr | tldr pages | Knowledge Base | Instagit

📚 Collaborative cheatsheets for console commands

GitHub Stars: 61.5k

Repository: https://github.com/tldr-pages/tldr

---

## Articles

### [Can You Contribute to Translations Without Fluency? tldr-pages Guidelines and Alternatives](/tldr-pages/tldr/contribute-translations-if-dont-know-language-tldr)

Explore tldr-pages translation guidelines. Learn if non-fluent speakers can contribute and discover alternative ways to help improve documentation even without fluency.

- Tags: best-practices
- Published: 2026-03-05

### [How to Update Existing Translations for tldr-pages: Scripts, Workflows, and Validation](/tldr-pages/tldr/how-to-update-existing-translations-tldr-pages)

Learn to update tldr page translations efficiently. Use Python scripts for synchronization and validation, ensuring accurate and up-to-date documentation across all locales.

- Tags: how-to-guide
- Published: 2026-03-05

### [How tldr-pages Handles Platform-Specific Variations of Commands](/tldr-pages/tldr/how-to-handle-platform-specific-variations-tldr)

Learn how tldr pages handle platform-specific command variations using a hierarchical directory structure. Discover OS-specific pages and common commands.

- Tags: internals
- Published: 2026-03-05

### [Difference Between pages and pages.locale Directories in tldr-pages](/tldr-pages/tldr/difference-between-pages-and-pages-locale-directories-tldr)

Understand the tldr-pages difference between pages/ and pages.<locale>/ directories. Discover how canonical English pages and translated locale pages are organized for clarity.

- Tags: internals
- Published: 2026-03-05

### [How to Create an Alias Page for an Existing Command in tldr-pages](/tldr-pages/tldr/how-to-create-alias-page-tldr)

Easily create alias pages for existing commands in tldr pages using the set alias page script. Generate standardized pages, apply translation templates, and sync across languages.

- Tags: how-to-guide
- Published: 2026-03-05

### [Required Format for Commit Messages in tldr-pages: Complete Guide](/tldr-pages/tldr/tldr-pages-commit-message-format)

Learn the required format for tldr-pages commit messages: command lowercase, colon, then concise change description. Master contributions to tldr-pages.

- Tags: best-practices
- Published: 2026-03-05

### [Inclusive Language Guidelines for tldr Pages: Complete Writing Standards](/tldr-pages/tldr/tldr-pages-inclusive-language-guidelines)

Discover tldr pages inclusive language guidelines. Learn to use imperative verbs gender neutral terms and avoid personal pronouns for clear documentation standards.

- Tags: best-practices
- Published: 2026-03-05

### [How to Use Translation Templates When Contributing Translated Pages to TLDR](/tldr-pages/tldr/how-to-use-tldr-translation-templates)

Learn to use TLDR translation templates by copying pre-translated snippets and using helper scripts for automatic synchronization. Contribute translated pages efficiently.

- Tags: how-to-guide
- Published: 2026-03-05

### [Contributing to tldr-pages: Guidelines and Pull Request Process Explained](/tldr-pages/tldr/tldr-pages-contributing-guidelines-pull-request)

Learn how to contribute to tldr pages. This guide explains the pull request process and guidelines for submitting new pages to the tldr-pages repository.

- Tags: how-to-guide
- Published: 2026-03-05

### [The Algorithm Used for Language Detection by tldr Clients: POSIX Locale Resolution](/tldr-pages/tldr/tldr-client-language-detection-algorithm)

Discover the POSIX locale resolution algorithm tldr clients use for language detection. Learn how environment variables determine your preferred language or default to English.

- Tags: internals
- Published: 2026-03-05

### [How tldr-pages Handles Naming Collisions for Command Pages: The Disambiguation System Explained](/tldr-pages/tldr/tldr-pages-naming-collisions-handling)

Discover how tldr-pages tackles naming collisions for command pages. Learn about their disambiguation system and dot-suffix naming conventions for clear command documentation.

- Tags: internals
- Published: 2026-03-05

### [How to Document Subcommands in tldr Pages: Standard Patterns and Examples](/tldr-pages/tldr/how-to-document-subcommands-tldr)

Learn standard patterns for documenting subcommands in tldr pages. Use placeholders and help examples effectively to improve your command-line documentation.

- Tags: best-practices
- Published: 2026-03-05

### [Understanding the tldr-pages Repository Directory Structure and Organization](/tldr-pages/tldr/tldr-pages-directory-structure-organization)

Explore the tldr-pages repository directory structure. Understand how pages, translations, and scripts are organized by language and OS for efficient access and contributions.

- Tags: internals
- Published: 2026-03-05

### [How to Test TLDR Pages Locally Using tldr-lint: Complete Validation Guide](/tldr-pages/tldr/how-to-test-tldr-pages-locally-tldr-lint)

Easily test tldr pages locally with tldr-lint. Validate your TLDR pages against the style guide using this npm package. Run tldr-lint ./pages or target specific files for complete validation.

- Tags: how-to-guide
- Published: 2026-03-05

### [TLDR Client Specification Requirements: A Complete Implementation Guide](/tldr-pages/tldr/tldr-client-specification-requirements)

Understand the tldr client specification requirements for CLI arguments, page resolution, language detection, and caching. Implement official tldr clients effectively.

- Tags: architecture
- Published: 2026-03-05

### [How to Start Contributing to the tldr-pages Project: A Complete Workflow Guide](/tldr-pages/tldr/how-to-contribute-to-tldr-pages)

Learn how to contribute to the tldr-pages project. Follow our guide to sign the CLA, create pages, validate, and submit your pull request for the tldr-pages repo.

- Tags: how-to-guide
- Published: 2026-03-05

### [How the tldr Page Resolution Algorithm Works: Platform and Language Priority](/tldr-pages/tldr/tldr-page-resolution-algorithm-explained)

Understand the tldr page resolution algorithm. Discover how platform and language priority deterministically find command documentation for tldr clients.

- Tags: internals
- Published: 2026-03-05

### [Understanding Placeholder Syntax in tldr Pages: How {{ }} Works](/tldr-pages/tldr/how-to-use-tldr-placeholder-syntax)

Learn how tldr pages use {{ }} placeholder syntax to represent variables like file paths and arguments. Easily copy and adapt command examples by substituting your own values.

- Tags: deep-dive
- Published: 2026-03-05

### [TLDR Platform-Specific Pages: Understanding Common vs Linux, Windows, and Other OS Directories](/tldr-pages/tldr/tldr-pages-platform-specific-pages)

Understand TLDR page differences between common, Linux, Windows, and other OS directories. Learn which commands apply to your operating system.

- Tags: internals
- Published: 2026-03-05

### [How Translations Are Managed and Implemented in tldr-pages](/tldr-pages/tldr/how-tldr-pages-translations-work)

Learn how tldr-pages manages and implements translations using parallel directories and automated Python scripts to sync changes from English source files to localized versions effectively.

- Tags: internals
- Published: 2026-03-05

### [Standard Markdown Syntax and Format for tldr Pages: The Complete Style Guide](/tldr-pages/tldr/tldr-page-markdown-syntax-format)

Master tldr pages Markdown syntax with this complete style guide. Learn the standard format including H1 titles blockquotes and command examples for clear documentation.

- Tags: best-practices
- Published: 2026-03-05

### [How to Add a New Command Page to the tldr-pages Project](/tldr-pages/tldr/how-to-add-new-command-page-tldr)

Learn how to add a new command page to the tldr-pages project by formatting Markdown, validating with tldr-lint, and submitting a pull request. Contribute to your favorite command-line tool documentation.

- Tags: how-to-guide
- Published: 2026-03-05