tldr

📚 Collaborative cheatsheets for console commands

22 articles

Can You Contribute to Translations Without Fluency? tldr-pages Guidelines and Alternatives

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

best-practices

Mar 5, 2026

How to Update Existing Translations for tldr-pages: Scripts, Workflows, and Validation

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

how-to-guide

Mar 5, 2026

How tldr-pages Handles Platform-Specific Variations of Commands

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

internals

Mar 5, 2026

Difference Between pages and pages.locale Directories in tldr-pages

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

internals

Mar 5, 2026

How to Create an Alias Page for an Existing Command in tldr-pages

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.

how-to-guide

Mar 5, 2026

Required Format for Commit Messages in tldr-pages: Complete Guide

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

best-practices

Mar 5, 2026

Inclusive Language Guidelines for tldr Pages: Complete Writing Standards

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

best-practices

Mar 5, 2026

How to Use Translation Templates When Contributing Translated Pages to TLDR

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

how-to-guide

Mar 5, 2026

Contributing to tldr-pages: Guidelines and Pull Request Process Explained

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.

how-to-guide

Mar 5, 2026

The Algorithm Used for Language Detection by tldr Clients: POSIX Locale Resolution

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

internals

Mar 5, 2026

How tldr-pages Handles Naming Collisions for Command Pages: The Disambiguation System Explained

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

internals

Mar 5, 2026

How to Document Subcommands in tldr Pages: Standard Patterns and Examples

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

best-practices

Mar 5, 2026

Have a question about this repo?

These articles cover the highlights, but your codebase questions are specific. Give your agent direct access to the source. Share this with your agent to get started:

Share the following with your agent to get started:

curl -s "https://instagit.com/install.md"

Add to your MCP client configuration:

{
  "mcpServers": {
    "instagit": {
      "command": "npx",
      "args": ["-y", "instagit@latest"]
    }
  }
}

Ask your agent:

"Use Instagit MCP to understand how tldr-pages/tldr works."

Works with

Claude Codex Cursor VS Code OpenClaw Any MCP Client

Maintain an open-source project? Get it listed too →