Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/k3mist/tldr
tldr in golang - Simplified and community-driven man pages
https://github.com/k3mist/tldr
command-line console documentation golang man-page manpages shell terminal tldr
Last synced: 25 days ago
JSON representation
tldr in golang - Simplified and community-driven man pages
- Host: GitHub
- URL: https://github.com/k3mist/tldr
- Owner: k3mist
- License: mit
- Created: 2017-11-24T20:50:12.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-04-21T21:03:43.000Z (over 1 year ago)
- Last Synced: 2024-07-30T20:54:27.816Z (4 months ago)
- Topics: command-line, console, documentation, golang, man-page, manpages, shell, terminal, tldr
- Language: Go
- Homepage:
- Size: 45.5 MB
- Stars: 17
- Watchers: 3
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# tldr in golang
[TLDR pages](https://tldr-pages.github.io/) - Simplified and community-driven man pages
## Install
```
go install bitbucket.org/djr2/tldr@latest
```
## Download
* [Distributions](https://bitbucket.org/djr2/tldr/src/master/dist/)
## Building and Build Requirements
* go
* upx -- https://github.com/upx/upx
* tar
```
bin/build
```
The build script will compile and compress the tldr executables.
The build script currently supports the following platforms and architectures;
* darwin arm64
* darwin amd64
* linux arm64
* linux amd64
* windows amd64
To a build a specific platform version run the below commands.
It is important to replace `[platform]` with the desired operating system and
`[arch]` with the desired platform architecture to build the executable correctly.
Supported Go build platforms and architectures can be found here;
https://golang.org/doc/install/source#environment
It is not necessary to run upx but it greatly reduces executable size.
```bash
GOOS=[platform] GOARCH=[arch] go build -ldflags="-s -w" -o tldr
upx --brute tldr # executable compression
```
## Usage
```
Usage:
-c page
clear cache for a tldr page
page -- Use `clearall` to clear entire cache
-p is required if clearing cache for a specific platform
-debug string
enables debug logging (default "disable")
-p platform
platform of the tldr page
platform -- common, linux, osx, sunos, windows (default "common")
```
### View a tldr
```
tldr
```
### View a tldr for a specific platform
```
tldr -p osx
```
### Clear a tldr
```
tldr -c
```
### Clear a tldr for a specific platform
```
tldr -c -p osx
```
### Clear entire cache
```
tldr -c clearall
```
## Configuration
A configuration is created the first time `tldr` is run.
The configuration is located at;
```
$HOME/.tldr/config.json
```
Pages repository URI, Zip URI, and all of the output colors are
configurable.
Below is the default configuration.
```
{
"pages_uri": "",
"zip_uri": "",
"banner_color_1": 36,
"banner_color_2": 34,
"tldr_color": 97,
"header_color": 34,
"header_decor_color": 97,
"platform_color": 90,
"description_color": 0,
"example_color": 36,
"hypen_color": 0,
"syntax_color": 31,
"variable_color": 0
}
```
If plain (default) terminal text is desired set all color options to `0`.
`pages_uri` and `zip_uri` when left blank will use the official TLDR
locations.
These can be used to test pages from a custom repository
or any zip collection that follows the official TLDR directory format
and file specification.
Pages: `https://raw.githubusercontent.com/tldr-pages/tldr/main/pages/`
Zip: `https://tldr-pages.github.io/assets/tldr.zip`
To reset the configuration back to its defaults delete `config.json`
and it will be recreated. Or copy and paste the configuration from
this README above.
## License
[MIT License](https://bitbucket.org/djr2/tldr/src/master/LICENSE.md)