All Projects → mstruebing → Tldr

mstruebing / Tldr

Licence: mit
Golang command line client for tldr https://github.com/tldr-pages/tldr

Programming Languages

go
31211 projects - #10 most used programming language
golang
3204 projects

Projects that are alternatives of or similar to Tldr

Mongo Seeding
The ultimate solution for populating your MongoDB database.
Stars: ✭ 375 (+78.57%)
Mutual labels:  cli-app, cli, hacktoberfest
Cheat.sh
the only cheat sheet you need
Stars: ✭ 27,798 (+13137.14%)
Mutual labels:  cli, tldr, help
Ava
Node.js test runner that lets you develop with confidence 🚀
Stars: ✭ 19,458 (+9165.71%)
Mutual labels:  cli-app, cli, hacktoberfest
Archisteamfarm
C# application with primary purpose of idling Steam cards from multiple accounts simultaneously.
Stars: ✭ 7,219 (+3337.62%)
Mutual labels:  cli-app, cli, hacktoberfest
Rust Sloth
A 3D software rasterizer... for the terminal!
Stars: ✭ 478 (+127.62%)
Mutual labels:  cli-app, cli, hacktoberfest
Tldr
📚 Collaborative cheatsheets for console commands
Stars: ✭ 36,408 (+17237.14%)
Mutual labels:  hacktoberfest, tldr, help
Alienfx
AlienFX is a CLI and GUI utility to control the lighting effects of your Alienware computer.
Stars: ✭ 140 (-33.33%)
Mutual labels:  cli, hacktoberfest
Simplesh
🐧 Quick installation for Ubuntu terminal.
Stars: ✭ 152 (-27.62%)
Mutual labels:  cli, hacktoberfest
Json 2 Csv
Convert JSON to CSV *or* CSV to JSON!
Stars: ✭ 210 (+0%)
Mutual labels:  cli, hacktoberfest
Tox
Command line driven CI frontend and development task automation tool.
Stars: ✭ 2,523 (+1101.43%)
Mutual labels:  cli, hacktoberfest
Kosko
Organize Kubernetes manifests in JavaScript.
Stars: ✭ 133 (-36.67%)
Mutual labels:  cli-app, cli
Fselect
Find files with SQL-like queries
Stars: ✭ 3,103 (+1377.62%)
Mutual labels:  cli, hacktoberfest
Gcli
🖥 Go CLI application, tool library, running CLI commands, support console color, user interaction, progress display, data formatting display, generate bash/zsh completion add more features. Go的命令行应用,工具库,运行CLI命令,支持命令行色彩,用户交互,进度显示,数据格式化显示,生成bash/zsh命令补全脚本
Stars: ✭ 188 (-10.48%)
Mutual labels:  cli-app, cli
Plugin Installation Manager Tool
Plugin Manager CLI tool for Jenkins
Stars: ✭ 138 (-34.29%)
Mutual labels:  cli, hacktoberfest
Git Tidy
Tidy up stale git branches.
Stars: ✭ 137 (-34.76%)
Mutual labels:  cli-app, cli
Pully
A simple CLI and library for downloading high quality YouTube videos!
Stars: ✭ 153 (-27.14%)
Mutual labels:  cli, hacktoberfest
Ohshitgit
⁉️Oh shit! A cli tool to help you unfuck your git mistakes
Stars: ✭ 135 (-35.71%)
Mutual labels:  cli-app, cli
Fpl
An asynchronous Python wrapper for the Fantasy Premier League API.
Stars: ✭ 169 (-19.52%)
Mutual labels:  cli, hacktoberfest
Tty
Toolkit for developing sleek command line apps.
Stars: ✭ 2,329 (+1009.05%)
Mutual labels:  cli-app, cli
Grank
Github 项目活跃度分析工具
Stars: ✭ 199 (-5.24%)
Mutual labels:  cli, hacktoberfest

tldr

Buy Me A Coffee

Build Status codecov Go Report Card

This tool shows the most common used parameter to different CLI-tools. This prevents long reading of help-flag output and man pages.

Example Output

Usage

usage: tldr [OPTION]... SEARCH

available commands:
    -v, --version           print version and exit
    -h, --help              print this help and exit
    -u, --update            update local database
    -p, --platform PLATFORM select platform, supported are linux / osx / sunos / common
    -a, --list-all          list all available commands for the current platform
    -f, --path PATH			render a local page(file) for testing purposes
    -r, --random			print a random page

Install

Just copy the executable anywhere on your system, preferably in some folder where your $PATH variable will find it.

Executables to every release can be found on the release page of this repository.

If you want to build it yourself see below.

On Arch Linux you can simply:

yaourt -S tldr-go-client-git or trizen -S tldr-go-client-git, or any other aur-helper. This also auto install bash and zsh completions.

Docker (mstruebing/tldr)

You can use a docker image:

docker pull mstruebing/tldr and execute it via: docker run -it mstruebing/tldr tldr tar for example. If you want to connect into the container and execute more commands you can use docker run -it mstruebing/tldr sh.

Dependencies

You don't need any runtime dependencies.

To build it yourself you just need golang(1.8 and 1.9 are currently tested) installed.

Building

If you want to build it yourself you can use the Makefile and type make build. This will put the tldr binary in a bin folder. If you want to compile it without it just do a go build in the root of this repository.

To install it on your system you can do a simple sudo make install in the root of this repository. This will build the executable file and install it to /usr/bin as well as zsh and bash autocompletions. You can install it into an other directory with:

INSTALL_DIR=/path/where/you/want/the/binary/to/live sudo make install

Make sure you have this directory in your $PATH. Otherwise you can build the executable yourself and copy it wherever you want. Or simply adjust the Makefile to your needs.

command effect
make build builds the binary for your current platform and places it in ./bin/
make install runs build and copies the binary to ~/bin/
make test runs tests
make build-all-binaries builds all binaries for currently supported platforms
make compress-all-binaries runs build-all-binaries and compresses them
make clean cleans ./bin/ and cache folders

Autocompletion

Currently this tool provides autocompletion for zsh and bash.

Bash

In bash you simply need to source the file (source autocomplete.bash).

source autocompletion/autocomplete.bash

You can put this into your .bashrc:

source <path/to/repo>/autocompletion/autocomplete.bash

Zsh

Currently only tested with oh-my-zsh: In zsh you need to copy or symlink autocomplete.zsh to $ZSH_CUSTOM/plugins/tldr/_tldr.

copy:

mkdir -p $ZSH_CUSTOM/plugins/tldr && 
cp autocompletion/autocomplete.zsh $ZSH_CUSTOM/plugins/tldr/_tldr

symlink:

mkdir -p $ZSH_CUSTOM/plugins/tldr && 
ln -s autocompletion/autocomplete.zsh $ZSH_CUSTOM/plugins/tldr/_tldr

And then define it in your .zshrc as a plugin:

plugins=(git tldr otherPlug)

Contribution

Please read CONTRIBUTING.md

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].