Aide commande Bash
https://github.com/pepa65/tldr-bash-client.git
Sanitized source |
||
---|---|---|
#tldr | ||
LICENSE | ||
README.md | ||
tldr | ||
tldr-customize.jpg | ||
tldr-list.jpg | ||
tldr-markdown-new.jpg | ||
tldr-markdown.jpg | ||
tldr-page.gif | ||
tldr-page.jpg | ||
tldr-usage.jpg |
README.md
tldr-bash-client
- version 0.1a
- https://github.com/pepa65/tldr-bash-client
A fully-functional bash client for the tldr project, providing poignant examples of terminal commands.
![tldr list tldr list screenshot](/Robot/tldr-bash-client/media/commit/f7c0d509f0b791cf6060262ddf7959baa2be6fe7/tldr-list.jpg)
This client can render both the old and the new tldr markup format.
Installation
Download the tldr bash script to the install location:
location=/usr/local/bin/tldr # elevated privileges needed for some locations
sudo wget -qO $location https://raw.githubusercontent.com/pepa65/tldr-bash-client/master/tldr
sudo chmod +x $location
If the location is not in $PATH, you need to specify the path to run it.
![tldr page tldr page gif](/Robot/tldr-bash-client/media/commit/f7c0d509f0b791cf6060262ddf7959baa2be6fe7/tldr-page.gif)
![tldr page tldr page screenshot](/Robot/tldr-bash-client/media/commit/f7c0d509f0b791cf6060262ddf7959baa2be6fe7/tldr-page.jpg)
Prerequisites
coreutils, less, grep, unzip, curl / wget
![tldr usage tldr usage screenshot](/Robot/tldr-bash-client/media/commit/f7c0d509f0b791cf6060262ddf7959baa2be6fe7/tldr-usage.jpg)
Customisation
The colors and other styling of the 5 elements of tldr pages can be modified either by editing the first few lines of the scipt, or by setting the following environment variables:
- TLDR_TITLE_STYLE (defaults to: Newline Space Bold Yellow)
- TLDR_DESCRIPTION_STYLE (defaults to: Space Yellow)
- TLDR_EXAMPLE_STYLE (defaults to: Newline Bold Green)
- TLDR_CODE_STYLE (defaults to: Space Bold Blue)
- TLDR_VALUE_STYLE (defaults to: Bold Cyan)
Also the error color and page expiry can easily be set:
- TLDR_ERROR_COLOR (defaults to: Red)
- TLDR_EXPIRY (defaults to: 60)
![tldr customize tldr customize screenshot](/Robot/tldr-bash-client/media/commit/f7c0d509f0b791cf6060262ddf7959baa2be6fe7/tldr-customize.jpg)
Contributing
Please file an issue for a question, a bug or a feature request. Or even better, send a pull request!
![tldr markdown tldr markdown screenshot](/Robot/tldr-bash-client/media/commit/f7c0d509f0b791cf6060262ddf7959baa2be6fe7/tldr-markdown.jpg)
License
Relicensed under GPL v3+
![tldr new markdown tldr new markdown screenshot](/Robot/tldr-bash-client/media/commit/f7c0d509f0b791cf6060262ddf7959baa2be6fe7/tldr-markdown-new.jpg)