Minimum specifications for tldr pages command line clients

tldr pages are distributed under MIT license, so you are free to implement clients for any platform. There is already a long list of clients.

Architecture

• The pages should be stored in a pages folder.
• Within that folder, there should be a subfolder for each supported platform.
• Commands common for all platforms are listed in the common folder.

Clients should not load pages directly from the GitHub API, which has rate limits. Instead, they should load the page archive and/or page index from the static site https://tldr.sh:

• Pages archive is available at tldr.sh/assets/tldr.zip.
• Pages index is available at tldr.sh/assets/index.json.

Recommendations

We recommend that clients follow the same standards.

• It should have installation instructions and setup requirements.
• It should list supported features.
• It should follow the full client specification.