tldr: Haskell tldr client

[ bsd3, cli, library, program, web ] [ Propose Tags ]

Haskell tldr client with support for viewing tldr pages. Has offline cache for accessing pages. Visit https://tldr.sh for more details.


[Skip to Readme]
Versions [faq] 0.1.0.0, 0.2.0, 0.2.1, 0.2.2, 0.2.3, 0.2.4, 0.2.5, 0.3.0, 0.3.1, 0.4.0, 0.4.0.1, 0.4.0.2, 0.5.0, 0.5.1, 0.6.0, 0.6.1, 0.6.2, 0.6.3, 0.6.4, 0.7.0, 0.7.1, 0.8.0
Change log CHANGELOG.md
Dependencies ansi-terminal, base (>=4.7 && <5), bytestring, cmark, containers, directory, filepath, optparse-applicative, semigroups, text, tldr, typed-process [details]
License BSD-3-Clause
Copyright 2017 Sibi Prabakaran
Author Sibi Prabakaran
Maintainer sibi@psibi.in
Category Web, CLI
Home page https://github.com/psibi/tldr-hs#readme
Bug tracker https://github.com/psibi/tldr-hs/issues
Source repo head: git clone https://github.com/psibi/tldr-hs
Uploaded by psibi at 2020-03-30T04:48:57Z
Distributions Debian:0.4.0, LTSHaskell:0.4.0.1, NixOS:0.8.0, Stackage:0.4.0.1
Executables tldr
Downloads 7980 total (29 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs available [build log]
Last success reported on 2020-03-30 [all 1 reports]

Modules

[Index] [Quick Jump]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for tldr-0.6.4

[back to package description]

tldr

Build Status

Hackage Stackage Nightly Stackage LTS

Haskell client for tldr

Installation

See Github releases: https://github.com/psibi/tldr-hs/releases

Executables are available for all the three major platforms: Linux, Windows and MacOS.

Or

  1. Install stack
  2. stack install tldr

Usage

$ tldr --help
tldr - Simplified and community-driven man pages

Usage: tldr [-v|--version] ((-u|--update) | [-p|--platform PLATFORM] COMMAND)
  tldr Client program

Available options:
  -h,--help                Show this help text
  -v,--version             Show version
  -u,--update              Update offline cache of tldr pages
  -p,--platform PLATFORM   Prioritize specfic platform while searching. Valid
                           values include linux, osx, windows, sunos
  COMMAND                  name of the command

Or a much better example of the usage:

$ tldr tldr
tldr
Simplified man pages.More information: https://tldr.sh.

 - Get typical usages of a command (hint: this is how you got here!):
   tldr {{command}}

 - Show the tar tldr page for linux:
   tldr -p {{linux}} {{tar}}

 - Get help for a git subcommand:
   tldr {{git checkout}}

Snapshot

tldr