# tldr-cyg

> Simplified and community-driven man pages

Latest version **1.6.1** (published 2016-02-24) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install tldr-cyg
pnpm add tldr-cyg
yarn add tldr-cyg
bun add tldr-cyg
```

Provides the command `tldr`.

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.6.1 |
| Published | 2016-02-24 |
| First published | 2016-02-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 15 |
| Known vulnerabilities | 0 (+5 in 3 direct dependencies) |
| Install scripts | yes |
| Author | Shadowhand |
| Maintainers | r_shadowhand |
| Keywords | man, unix, linux, osx, commands, command-line, shell, bash, zsh |

## Links

- npm: https://www.npmjs.com/package/tldr-cyg
- Repository: https://github.com/tldr-pages/tldr-node-client-cygwin
- Homepage: http://tldr-pages.github.io
- Issues: https://github.com/tldr-pages/tldr-node-client-cygwin/issues
- npm.io page: https://npm.io/package/tldr-cyg

## Dependencies (15)

- [ms](https://npm.io/package/ms.md) ~0.7.1
- [colors](https://npm.io/package/colors.md) ~1.1.2
- [marked](https://npm.io/package/marked.md) ~0.3.5
- [rimraf](https://npm.io/package/rimraf.md) ~2.5.0
- [unzip2](https://npm.io/package/unzip2.md) ~0.2.5
- [wrench](https://npm.io/package/wrench.md) ~1.5.8
- [request](https://npm.io/package/request.md) ~2.69.0
- [commander](https://npm.io/package/commander.md) ~2.9.0
- [lodash.map](https://npm.io/package/lodash.map.md) ~4.2.0
- [os-homedir](https://npm.io/package/os-homedir.md) ~1.0.1
- [lodash.last](https://npm.io/package/lodash.last.md) ~3.0.0
- [lodash.sample](https://npm.io/package/lodash.sample.md) ~4.1.0
- [lodash.compact](https://npm.io/package/lodash.compact.md) ~3.0.0
- [lodash.defaults](https://npm.io/package/lodash.defaults.md) ~4.0.1
- [lodash.unescape](https://npm.io/package/lodash.unescape.md) ~4.0.0

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 1.6.1 (latest) — 2016-02-24

## README

# tldr-node-client

[![NPM version][npm-image]][npm-url]
[![Travs CI Build Status][travis-image]][travis-url]
[![AppVeyor CI Build status][appveyor-image]][appveyor-url]
[![David DM Dependency Status][dep-image]][dep-url]
[![David DM devDependency Status][dev-dep-image]][dev-dep-url]
[![Gitter chat][gitter-image]][gitter-url]

A `Node.js` based command-line client for [tldr](https://github.com/tldr-pages/tldr), for CYGWIN.

![tldr screenshot](http://raw.github.com/tldr-pages/tldr-node-client/master/screenshot.png)

## Installing

```bash
$ npm install -g tldr-cyg
```

## Usage

To see tldr pages:

- `tldr <command>` show examples for this command
- `tldr <command> --os=<platform>` show command page for the given platform (`linux`, `osx`, `sunos`)
- `tldr --linux <command>` show command page for Linux
- `tldr  --osx <command>` show command page for OSX
- `tldr --sunos <command>` show command page for SunOS
- `tldr --list` show all pages for current platform
- `tldr --list-all` show all available pages
- `tldr --random` show a page at random
- `tldr --random-example` show a single random example

The client caches a copy of all pages locally, in `~/.tldr`.
There are more commands to control the local cache:

- `tldr --update` download the latest pages
- `tldr --clear-cache` delete the entire local cache

As a contributor, you might also need the following commands:

- `tldr --render <path>` render a local page for testing purposes

## Configuration

You can configure the `tldr` client by adding a `.tldrrc` file in your HOME directory.
This file has to be valid JSON:

```json
{
  "colors": {
    "text": "green",
    "command-background": "black",
    "command-foreground": "red",
    "command-token": "white"
  }
}
```

If you regularly need pages for a different platform (e.g. Linux),
you can put it in the config file:

```json
{
  "platform": "linux"
}
```

The default platform value can be overwritten with command-line option:

```shell
tldr du --os=osx
```

As a contributor, you can also point to your own fork or branch:

```js
{
  "repository" : "myfork/tldr",
  // or
  "repository" : "myfork/tldr#mybranch",
}
```

## What changed?

I added only a single line to the top of tldr.js, which prevents the color from being sent to CYGWIN. Everything else is identical.

## Contributing

Contribution are most welcome!
Have a look [over here](https://github.com/tldr-pages/tldr-node-client/blob/master/.github/CONTRIBUTING.md)
for a few rough guidelines.

[npm-url]: https://www.npmjs.com/package/tldr
[npm-image]: https://img.shields.io/npm/v/tldr.svg

[travis-url]: https://travis-ci.org/tldr-pages/tldr-node-client
[travis-image]: https://img.shields.io/travis/tldr-pages/tldr-node-client.svg?label=linux

[appveyor-image]: https://img.shields.io/appveyor/ci/igorshubovych/tldr-node-client-bnut4.svg?label=windows
[appveyor-url]: https://ci.appveyor.com/project/igorshubovych/tldr-node-client-bnut4

[dep-url]: https://david-dm.org/tldr-pages/tldr-node-client
[dep-image]: https://david-dm.org/tldr-pages/tldr-node-client.svg?theme=shields.io

[dev-dep-url]: https://david-dm.org/tldr-pages/tldr-node-client#info=devDependencies
[dev-dep-image]: https://david-dm.org/tldr-pages/tldr-node-client/dev-status.svg?theme=shields.io

[gitter-url]: https://gitter.im/tldr-pages/tldr
[gitter-image]: https://badges.gitter.im/tldr-pages/tldr.png

---
_Source: https://npm.io/package/tldr-cyg · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._