https://github.com/brainmaestro/tldr-php

PHP Client for tldr
https://github.com/brainmaestro/tldr-php

php7 tldr tldr-pages tldr-php

Last synced: 3 months ago
JSON representation

PHP Client for tldr

• Host: GitHub
• URL: https://github.com/brainmaestro/tldr-php
• Owner: BrainMaestro
• License: mit
• Created: 2017-07-04T14:20:23.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-03-02T10:25:34.000Z (almost 2 years ago)
• Last Synced: 2024-04-24T10:19:24.431Z (9 months ago)
• Topics: php7, tldr, tldr-pages, tldr-php
• Language: PHP
• Size: 183 KB
• Stars: 20
• Watchers: 4
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# tldr-php

[![Travis](https://img.shields.io/travis/BrainMaestro/tldr-php.svg?style=flat-square)](https://travis-ci.org/BrainMaestro/tldr-php)

[![Packagist](https://img.shields.io/packagist/v/brainmaestro/tldr.svg?style=flat-square)](https://packagist.org/packages/brainmaestro/tldr)

> A `PHP` based command-line client for [tldr](https://github.com/tldr-pages/tldr).

![tldr screenshot](screenshot.png)

## Installing

```sh

composer global require brainmaestro/tldr

```

## Usage

To see tldr pages:

  

- `tldr ` show examples for this command

- `tldr  --p=` show command page for the given platform (`linux`, `osx`, `sunos`)

The client caches a copy of all pages locally, in `~/.tldr`.

There are more commands to control the local cache:

- `tldr --update` download latest version of pages in your local cache

- `tldr --clear-cache` delete the entire local cache

## Related

- [tldr-node-client](https://github.com/tldr-pages/tldr-node-client) - source of documentation and cache functionality

## License

MIT © Ezinwa Okpoechi