• Stars
    star
    281
  • Rank 143,510 (Top 3 %)
  • Language
    C
  • License
    MIT License
  • Created about 10 years ago
  • Updated 4 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

C command-line client for tldr pages

tldr c client

Build Status

A command line client for tldr, written in plain ISO C90.

Installing

On OS X, the client can be installed through Homebrew.

# To install latest development version
brew install tldr --HEAD

# To install the latest stable release
brew install tldr

On Arch Linux, the client can be installed through the AUR using an AUR helper such as yay.

yay -S tldr-git

To build the latest version from source:

git clone https://github.com/tldr-pages/tldr-c-client.git
cd tldr-c-client

./deps.sh           # install dependencies
make                # build tldr
make install        # install tldr

The default prefix for installation is /usr/local/bin.

Building

Building the tldr client is pretty straightforward.

Requirements

  • clang/gcc
  • libcurl (brew install curl / apt-get install libcurl-dev / apt-get install libcurl4-openssl-dev)
  • libzip (brew install libzip / apt-get install libzip-dev)
  • pkg-config (brew install pkg-config / apt-get install pkg-config)

Compiling

The Makefile in the root directory has all you need for builing the project.

Just call make and tldr will build itself.

make

Autocompletion

Autocompletion is supported for bash, zsh, and fish and can be added by sourcing the correct autocompletion file.

The files autocomplete.zsh, autocomplete.bash, and autocomplete.fish can be found in the autocomplete folder in the root of the repository.

Installation

To install the autocompletion, just move the script for your shell to an easy to access directory (like your home directory), and source it in your .bashrc or .zshrc.

Example for zsh:

mv autocomplete/complete.zsh ~/.tldr.complete
echo "source ~/.tldr.complete" >> ~/.zshrc

Usage

usage: ./tldr [-v] [OPTION]... SEARCH

available commands:
    -v                   print verbose output
    --version            print version and exit
    -h, --help           print this help and exit
    -u, --update         update local database
    -c, --clear-cache    clear local database
    -p, --platform=PLATFORM select platform, supported are linux / osx / sunos / common
    -r, --render=PATH    render a local page for testing purposes

Configuration

To prevent tldr from automatically updating its database, set the environment variable TLDR_AUTO_UPDATE_DISABLED.

Contributing

Please read the CONTRIBUTING.md for details.

License

The MIT License (MIT) - see LICENSE for details.

More Repositories

1

tldr

πŸ“š Collaborative cheatsheets for console commands
Markdown
49,026
star
2

tldr-python-client

Python command-line client for tldr pages
Python
569
star
3

tldr-node-client

Node.js command-line client for tldr pages
JavaScript
425
star
4

tlrc

A tldr client written in Rust
Rust
139
star
5

tldr-pages.github.io

The website for the tldr pages project
HTML
70
star
6

tldr-lint

A linting tool to validate tldr pages
JavaScript
33
star
7

tldr-bot

A simple bot that performs automation tasks on the main tldr repo
Python
28
star
8

extldr

Elixir command-line client for tldr pages
Elixir
14
star
9

tldr-maintenance

This repository runs a Bash script that calculates metrics about the current state of the tldr pages
Shell
6
star
10

tldr-neovim-extension

TLDR Neovim Extension is a plugin that integrates TLDR pages directly into Neovim.
Lua
5
star
11

homebrew-tldr

!!! DEPRECATED !!!
Ruby
4
star
12

tldr.jsx-fork

πŸ“š A Reactive web client for tldr-pages
JavaScript
4
star
13

tldr-translation-pairs-gen

Generates a structured dataset in various formats derived from tldr-pages.
TypeScript
4
star
14

tldr-labeler-action

Action to handle automatic PR labeling
TypeScript
4
star
15

tldr-pages-test-harness

A Bats test-suite that validates if a tldr-client is compatible with the client specifications set out in the tldr repository.
Shell
3
star
16

tldr-emacs-extension

Emacs extension for TlDr.
Emacs Lisp
1
star
17

tldr-json-schemas

JSON schemas to describe command syntax and enable example parsing easily.
1
star
18

.github

1
star
19

tldr-code-extension

1
star
20

tldr-bash-framework

Framework for handling errors gracefully, colorize text and parse options in a readable manner.
Shell
1
star
21

tldr-editor-configs

Editor configs for TlDr for editors without plugin support.
1
star
22

chatroom

Redirect to the tldr-pages chatroom.
HTML
1
star