tldr – LexYu Hive

tldr

簡略化(かんりゃくか) された man pages。コマンドの使(つか) い方(かた) を素早(すばや) く検索(けんさく)

インストール

# macOS
brew install tldr

# npm
npm install -g tldr

# pip
pip install tldr

# Arch Linux
sudo pacman -S tldr

基本使用法

# コマンドを検索
tldr tar
tldr git-commit
tldr docker-run

# ローカルキャッシュを更新
tldr --update

プラットフォームを指定

# Linux 専用コマンド
tldr -p linux apt

# macOS 専用コマンド
tldr -p osx brew

# Windows 専用コマンド
tldr -p windows choco

# 共通コマンド
tldr -p common git

出力例

$ tldr tar

  tar

  Archiving utility.
  Often combined with a compression method, such as gzip or bzip2.
  More information: https://www.gnu.org/software/tar

  - [c]reate an archive and write it to a [f]ile:
    tar cf target.tar file1 file2 file3

  - [c]reate a g[z]ipped archive and write it to a [f]ile:
    tar czf target.tar.gz file1 file2 file3

  - E[x]tract a (compressed) archive [f]ile:
    tar xf source.tar[.gz|.bz2|.xz]

他のクライアント

tealdeer (Rust 実装)

より高速(こうそく) な代替(だいたい) 品(ひん)

# インストール
brew install tealdeer
cargo install tealdeer

# 使用
tldr tar

オンライン版

ページを貢献

tldr はコミュニティ駆動(くどう) のプロジェクト。新(あたら) しいページを貢献(こうけん) できます：

tldr-pages/tldr をフォーク
pages/ ディレクトリに新(あたら) しいページを追加(ついか)
Pull Request を提出(ていしゅつ)

ページ形式

# command-name

> Short description.
> More information: <https://example.com>.

- Description of first example:

`command --option`

- Description of second example:

`command --option {{argument}}`

man との比較

特性(とくせい)	tldr	man
長(なが) さ	簡潔(かんけつ) で実用的(じつようてき)	完全(かんぜん) で詳細(しょうさい)
例(れい)	一般的(いっぱんてき) な使用法(しようほう)	少(すく) ない
更新(こうしん)	コミュニティ管理(かんり)	システム付属(ふぞく)
オフライン	キャッシュ必要(ひつよう)	インストール済(ず) み

shellcheck tmux